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

#ifndef NMXP_CHAN_H
#define NMXP_CHAN_H 1

#include <sys/types.h>

/*! \brief The key/name info for one channel */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
18
typedef struct {
19
20
    uint32_t key;
    char name[12];
Matteo Quintiliani's avatar
Matteo Quintiliani committed
21
} NMXP_CHAN_KEY;
22

Matteo Quintiliani's avatar
Matteo Quintiliani committed
23
/*! \brief Max number of channels */
24
#define MAX_N_CHAN 1000
Matteo Quintiliani's avatar
Matteo Quintiliani committed
25
26
27

/*! \brief Channel list */
typedef struct {
28
    uint32_t number;
Matteo Quintiliani's avatar
Matteo Quintiliani committed
29
30
    NMXP_CHAN_KEY channel[MAX_N_CHAN];
} NMXP_CHAN_LIST;
31
32


Matteo Quintiliani's avatar
Matteo Quintiliani committed
33
34
35
36
37
38
39
40
/*! \brief Type of Data */
typedef enum {
    NMXP_DATA_TIMESERIES	= 1,
    NMXP_DATA_SOH		= 2,
    NMXP_DATA_TRANSERIAL	= 6
} NMXP_DATATYPE;


41
/*! \brief Looks up a channel key in the list using the name
42
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
43
44
 * \param name Channel name.
 * \param channelList Channel list.
45
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
46
 * \return Key of the channel with name. -1 On error.
47
48
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
49
int nmxp_chan_lookupKey(char* name, NMXP_CHAN_LIST *channelList);
50

51
/*! \brief Looks up a channel name in the list using a key
52
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
53
54
 * \param key Channel key.
 * \param channelList Channel list.
55
 *
Matteo Quintiliani's avatar
Matteo Quintiliani committed
56
 * \return Name of channel with key. NULL on error.
57
58
 *
 */
Matteo Quintiliani's avatar
Matteo Quintiliani committed
59
char *nmxp_chan_lookupName(uint32_t key, NMXP_CHAN_LIST *channelList);
60

61
62
63
64
65
66
67
68
69
70
/*! \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
71
NMXP_CHAN_LIST *nmxp_chan_getType(NMXP_CHAN_LIST *channelList, NMXP_DATATYPE dataType);
72

73
74
#endif