nmxp_chan.h 4.14 KB
Newer Older
1
2
/*! \file
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
3
 * \brief Channels for Nanometrics Protocol Library
4
5
6
7
8
9
10
11
12
13
14
 *
 * Author:
 * 	Matteo Quintiliani
 * 	Istituto Nazionale di Geofisica e Vulcanologia - Italy
 *	quintiliani@ingv.it
 *
 */

#ifndef NMXP_CHAN_H
#define NMXP_CHAN_H 1

15
#include <stdint.h>
16

17
18
19
20
21
22
23
/*! \brief Type of Data */
typedef enum {
    NMXP_DATA_TIMESERIES	= 1,
    NMXP_DATA_SOH		= 2,
    NMXP_DATA_TRANSERIAL	= 6
} NMXP_DATATYPE;

24
/*! \brief The key/name info for one channel */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
25
typedef struct {
26
27
    uint32_t key;
    char name[12];
Matteo Quintiliani's avatar
Matteo Quintiliani committed
28
} NMXP_CHAN_KEY;
29

Matteo Quintiliani's avatar
Matteo Quintiliani committed
30
/*! \brief Max number of channels */
31
#define MAX_N_CHAN 1000
Matteo Quintiliani's avatar
Matteo Quintiliani committed
32
33
34

/*! \brief Channel list */
typedef struct {
35
    uint32_t number;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
36
37
    NMXP_CHAN_KEY channel[MAX_N_CHAN];
} NMXP_CHAN_LIST;
38

39
40
41
42
43
44
45
46
47
48
49
50
51
/*! \brief Precis Channel item */
typedef struct {
    uint32_t key;
    char name[12];
    uint32_t start_time;
    uint32_t end_time;
} NMXP_CHAN_PRECISITEM;

/*! \brief Precis Channel list */
typedef struct {
    uint32_t number;
    NMXP_CHAN_PRECISITEM channel[MAX_N_CHAN];
} NMXP_CHAN_PRECISLIST;
52

53
54
55
56
57
/*! \brief Precis list requst body */
typedef struct {
    int32_t instr_id;
    NMXP_DATATYPE datatype;
    int32_t type_of_channel;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
58
} NMXP_MSGBODY_PRECISLISTREQUEST;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
59
60


61
62
63
64
/*! \brief Character separator for channel list */
#define sep_chan_list  ','


65
66
67
68
/*! \brief Return type of data from a channel key */
#define getDataTypeFromKey(key) ((key >> 8) & 0xff)


69

70
71
/*! \brief Copy station code and channel code from name
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
72
 * \param station_dot_channel string containing STA.CHAN
73
74
75
76
77
78
79
80
81
82
83
84
 * \param[out] station_code Pointer to string for station code
 * \param[out] channel_code Pointer to string for char code
 *
 * \warning Parametes can not be NULL!
 *
 * \retval 1 on success
 * \retval 0 on error
 *
 */
int nmxp_chan_cpy_sta_chan(const char *station_dot_channel, char *station_code, char *channel_code);


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/*! \brief Match station_dot_channel against pattern, treating errors as no match.
 *
 * \param station_dot_channel STA.CHAN format
 * \param pattern STA.?HZ or STA.H?Z or STA.HH? or STA.?H? or ....
 *
 * \retval 1 for match
 * \retval 0 for no match
 * \retval -1 on error for invalid pattern
 * \retval -2 on error for invalid station_dot_channel
 *
 */
int nmxp_chan_match(const char *station_dot_channel, char *pattern);



100
/*! \brief Looks up a channel key in the list using the name
101
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
102
103
 * \param name Channel name.
 * \param channelList Channel list.
104
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
105
 * \return Key of the channel with name. -1 On error.
106
107
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
108
int nmxp_chan_lookupKey(char* name, NMXP_CHAN_LIST *channelList);
109

110
111
112
113
114
115
116
117
118
119
120
121

/*! \brief Looks up a channel name in the list using a key
 *
 * \param key Channel key.
 * \param channelList Channel list.
 *
 * \return Index of channel with key. -1 on error.
 *
 */
int nmxp_chan_lookupKeyIndex(uint32_t key, NMXP_CHAN_LIST *channelList);


122
/*! \brief Looks up a channel name in the list using a key
123
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
124
125
 * \param key Channel key.
 * \param channelList Channel list.
126
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
127
 * \return Name of channel with key. NULL on error.
128
129
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
130
char *nmxp_chan_lookupName(uint32_t key, NMXP_CHAN_LIST *channelList);
131

132

133
134
135
136
137
138
139
140
141
142
/*! \brief Looks up a channel with specified data type.
 *
 * \param channelList Channel list.
 * \param dataType Type of channel.
 *
 * \return Channel list with specified dataType. It will need to be freed!
 *
 * \warning Returned value will need to be freed!
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
143
NMXP_CHAN_LIST *nmxp_chan_getType(NMXP_CHAN_LIST *channelList, NMXP_DATATYPE dataType);
144

145

146
147
148
149
/*! \brief Looks up a channel with specified data type.
 *
 * \param channelList Channel list.
 * \param dataType Type of channel.
150
 * \param sta_chan_list String list of item STA.CHAN, separeted by comma.
151
152
153
154
155
156
157
158
159
 *
 * \return Channel list with specified dataType. It will need to be freed!
 *
 * \warning Returned value will need to be freed!
 *
 */
NMXP_CHAN_LIST *nmxp_chan_subset(NMXP_CHAN_LIST *channelList, NMXP_DATATYPE dataType, char *sta_chan_list);


160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
/*! Sort list by channel key
 *
 * \param channelList Channel List
 *
 */
void nmxp_chan_sortByKey(NMXP_CHAN_LIST *channelList);


/*! Sort list by channel name
 *
 * \param channelList Channel List
 *
 */
void nmxp_chan_sortByName(NMXP_CHAN_LIST *channelList);

175
176
177
178
179
180
181
182

/*! Print channel information
 *
 * \param channelList Channel List
 *
 */
void nmxp_chan_print_channelList(NMXP_CHAN_LIST *channelList);

183
184
#endif