nmxp_chan.h 5.44 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

Matteo Quintiliani's avatar
Matteo Quintiliani committed
17
18
19
20
21
22
23
24
25
26
/*! \brief Channel list */
typedef struct NMXP_META_CHAN_LIST {
    int32_t key;
    char name[12];
    int32_t start_time;
    int32_t end_time;
    char network[12];
    struct NMXP_META_CHAN_LIST *next;
} NMXP_META_CHAN_LIST;

27

28
/*! \brief The key/name info for one channel */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
29
typedef struct {
Matteo Quintiliani's avatar
Matteo Quintiliani committed
30
    int32_t key;
31
    char name[12];
Matteo Quintiliani's avatar
Matteo Quintiliani committed
32
} NMXP_CHAN_KEY;
33

Matteo Quintiliani's avatar
Matteo Quintiliani committed
34
/*! \brief Max number of channels */
35
#define MAX_N_CHAN 1000
Matteo Quintiliani's avatar
Matteo Quintiliani committed
36
37
38

/*! \brief Channel list */
typedef struct {
39
    uint32_t number;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
40
41
    NMXP_CHAN_KEY channel[MAX_N_CHAN];
} NMXP_CHAN_LIST;
42

43
44
/*! \brief Precis Channel item */
typedef struct {
Matteo Quintiliani's avatar
Matteo Quintiliani committed
45
    int32_t key;
46
47
48
49
50
51
52
53
54
55
    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;
56

Matteo Quintiliani's avatar
Matteo Quintiliani committed
57
58
59
60
61
62
63
64
/*! \brief Type of Data */
typedef enum {
    NMXP_DATA_TIMESERIES	= 1,
    NMXP_DATA_SOH		= 2,
    NMXP_DATA_TRANSERIAL	= 6
} NMXP_DATATYPE;

/*! \brief Precis list request body */
65
66
67
68
typedef struct {
    int32_t instr_id;
    NMXP_DATATYPE datatype;
    int32_t type_of_channel;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
69
} NMXP_MSGBODY_PRECISLISTREQUEST;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
70

Matteo Quintiliani's avatar
Matteo Quintiliani committed
71
72
73
74
75
76
77
78
79
80
81
82
83
/*! \brief Channel info request body */
typedef struct {
    int32_t key;
    char name[12];
    char network[12];
} NMXP_MSGBODY_CHANNELINFORESPONSE;

/*! \brief Channel info request body */
typedef struct {
    int32_t key;
    int32_t ignored;
} NMXP_MSGBODY_CHANNELINFOREQUEST;

Matteo Quintiliani's avatar
Matteo Quintiliani committed
84

85
86
87
88
/*! \brief Character separator for channel list */
#define sep_chan_list  ','


89
90
91
/*! \brief Return type of data from a channel key */
#define getDataTypeFromKey(key) ((key >> 8) & 0xff)

Matteo Quintiliani's avatar
Matteo Quintiliani committed
92
93
94
/*! \brief Return channel number from a channel key */
#define getChannelNumberFromKey(key) ((key) & 0x000f)

95

96

97
98
/*! \brief Copy station code and channel code from name
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
99
 * \param station_dot_channel string containing STA.CHAN
100
101
102
103
104
105
106
107
108
109
110
111
 * \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);


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
/*! \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);



127
/*! \brief Looks up a channel key in the list using the name
128
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
129
130
 * \param name Channel name.
 * \param channelList Channel list.
131
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
132
 * \return Key of the channel with name. -1 On error.
133
134
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
135
int nmxp_chan_lookupKey(char* name, NMXP_CHAN_LIST *channelList);
136

137
138
139
140
141
142
143
144
145

/*! \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.
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
146
int nmxp_chan_lookupKeyIndex(int32_t key, NMXP_CHAN_LIST *channelList);
147
148


149
/*! \brief Looks up a channel name in the list using a key
150
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
151
152
 * \param key Channel key.
 * \param channelList Channel list.
153
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
154
 * \return Name of channel with key. NULL on error.
155
156
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
157
char *nmxp_chan_lookupName(int32_t key, NMXP_CHAN_LIST *channelList);
158

159

160
161
162
163
164
165
166
167
168
169
/*! \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
170
NMXP_CHAN_LIST *nmxp_chan_getType(NMXP_CHAN_LIST *channelList, NMXP_DATATYPE dataType);
171

172

173
174
175
176
/*! \brief Looks up a channel with specified data type.
 *
 * \param channelList Channel list.
 * \param dataType Type of channel.
177
 * \param sta_chan_list String list of item STA.CHAN, separeted by comma.
178
179
180
181
182
183
184
185
186
 *
 * \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);


187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
/*! 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);

202
203
204
205
206
207
208
209

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

Matteo Quintiliani's avatar
Matteo Quintiliani committed
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224

void nmxp_meta_chan_free(NMXP_META_CHAN_LIST **chan_list);

NMXP_META_CHAN_LIST *nmxp_meta_chan_add(NMXP_META_CHAN_LIST **chan_list, int32_t key, char *name, int32_t start_time, int32_t end_time, char *network);

NMXP_META_CHAN_LIST *nmxp_meta_chan_search_key(NMXP_META_CHAN_LIST *chan_list, int32_t key);

NMXP_META_CHAN_LIST *nmxp_meta_chan_set_name(NMXP_META_CHAN_LIST *chan_list, int32_t key, char *name);

NMXP_META_CHAN_LIST *nmxp_meta_chan_set_times(NMXP_META_CHAN_LIST *chan_list, int32_t key, int32_t start_time, int32_t end_time);

NMXP_META_CHAN_LIST *nmxp_meta_chan_set_network(NMXP_META_CHAN_LIST *chan_list, int32_t key, char *network);

void nmxp_meta_chan_print(NMXP_META_CHAN_LIST *chan_list);

225
226
#endif