daqc.h

Go to the documentation of this file.

/* -*- tab-width:8 c-basic-offset:4  indent-tabs-mode:nil -*- */
/* set vi: ts=8:softtabstop=4,shiftwidth=4,expandtab */
 
/*
 *  Data acquisition daemon access
 */
#ifndef DAQC_H
#define DAQC_H
 
#if __cplusplus
extern "C" {
#endif /* __cplusplus */
 
#include "channel.h"
 
typedef int          int4_type;
typedef unsigned int uint4_type;
 
#define DAQD_PROTOCOL_VERSION 12
#define DAQD_PROTOCOL_REVISION 0
 
#define DAQD_PORT 31200
 
struct sockaddr_in;
 
struct signal_conv1;
 
struct daq_private_;
 
enum nds_version
{
 
    nds_try = 0,
 
    nds_v1 = 1,
 
    nds_v2 = 2
};
 
/* pieces of the communication protocol */
 
#define HEADER_LEN 16
 
typedef struct daq_block_header daq_block_t;
 
struct signal_conv_
{
    float signal_gain;
 
    float signal_slope;
 
    float signal_offset;
 
    char signal_units[ MAX_SIGNAL_UNIT_LENGTH ]; /* Engineering units  */
};
 
typedef struct signal_conv_ signal_conv_t;
 
struct chan_req_
{
    char* name;
 
    enum chantype type;
 
    double rate;
 
    daq_data_t data_type;
 
    uint4_type offset;
 
    int status;
 
    signal_conv_t s;
};
 
typedef struct chan_req_ chan_req_t;
 
struct daq_
{
    enum nds_version nds_versn;
 
    uint4_type num_chan_request;
 
    uint4_type num_chan_alloc;
 
    chan_req_t* chan_req_list;
 
    int blocks;
 
    daq_block_t* tb;
 
    size_t tb_size;
 
    struct signal_conv1* s;
 
    int s_size;
 
    int nds1_ver;
 
    int nds1_rev;
 
    void* auth_ctx;
 
    int err_num;
 
    struct daq_private_* conceal;
};
 
typedef struct daq_ daq_t;
 
struct daq_channel_
{
    char name[ MAX_LONG_CHANNEL_NAME_LENGTH + 1 ]; /* Channel name */
 
    double rate;
 
    int tpnum;
 
    enum chantype type;
 
    int bps;
 
    int chNum;
 
    daq_data_t data_type;
 
    signal_conv_t s;
};
 
typedef struct daq_channel_ daq_channel_t;
 
/*                   Channel Group interface (Version 1 Only)
 */
 
struct daq_channel_group_
{
    int group_num;
    char name[ MAX_CHANNEL_NAME_LENGTH + 1 ];
};
 
typedef struct daq_channel_group_ daq_channel_group_t;
 
DLL_EXPORT int daq_clear_channel_list( daq_t* daq );
 
DLL_EXPORT int
daq_connect( daq_t* daq, const char* host, int port, enum nds_version version );
 
DLL_EXPORT void daq_destroy( daq_t* daq );
 
DLL_EXPORT int daq_disconnect( daq_t* daq );
 
DLL_EXPORT const char* daq_get_channel_addr( daq_t* daq, const char* channel );
 
DLL_EXPORT char*
daq_get_channel_data( daq_t* daq, const char* channel, char* data );
 
DLL_EXPORT int daq_get_data_length( daq_t* daq, const char* channel );
 
DLL_EXPORT chan_req_t* daq_get_channel_status( daq_t*      daq,
                                               const char* channel );
 
DLL_EXPORT int
daq_get_last_message( daq_t* daq, char* buf, size_t max_len, int* len );
 
DLL_EXPORT int
daq_get_scaled_data( daq_t* daq, const char* channel, float* data );
 
DLL_EXPORT void daq_init( daq_t* daq );
 
DLL_EXPORT void daq_init_channel( daq_channel_t* chan,
                                  const char*    name,
                                  enum chantype  ctype,
                                  double         rate,
                                  daq_data_t     dtype );
 
DLL_EXPORT int daq_is_connected( daq_t* daq );
 
DLL_EXPORT int daq_recv_block_num( daq_t* daq );
 
DLL_EXPORT int daq_recv_block( daq_t* daq );
 
DLL_EXPORT int daq_recv_next( daq_t* daq );
 
DLL_EXPORT int daq_recv_shutdown( daq_t* daq );
 
DLL_EXPORT int daq_recv_channels( daq_t*         daq,
                                  daq_channel_t* channel,
                                  int            num_channels,
                                  int*           num_channels_received );
 
DLL_EXPORT int daq_recv_channel_hash(
    daq_t* daq, void* hash, int* length, time_t gps, enum chantype type );
 
DLL_EXPORT int daq_recv_hash_by_pattern( daq_t*        daq,
                                         void*         hash,
                                         int*          length,
                                         time_t        gps,
                                         enum chantype type,
                                         const char*   pat );
 
DLL_EXPORT int daq_recv_channel_list( daq_t*         daq,
                                      daq_channel_t* channel,
                                      int            num_channels,
                                      int*           num_channels_received,
                                      time_t         gps,
                                      enum chantype  type );
 
DLL_EXPORT int daq_recv_channels_by_pattern( daq_t*         daq,
                                             daq_channel_t* channel,
                                             int            num_channels,
                                             int*   num_channels_received,
                                             time_t gps,
                                             enum chantype type,
                                             const char*   pat );
 
DLL_EXPORT int
daq_recv_epoch_list( daq_t* daq, char* epochs, size_t max_len, int* str_len );
 
DLL_EXPORT long daq_recv_id( daq_t* daq );
 
DLL_EXPORT int daq_recv_source_data(
    daq_t* daq, char* sources, size_t max_len, time_t gps, long* str_len );
 
DLL_EXPORT int daq_recv_source_list(
    daq_t* daq, char* sources, size_t max_len, time_t gps, long* str_len );
 
DLL_EXPORT int daq_request_channel( daq_t*        daq,
                                    const char*   name,
                                    enum chantype type,
                                    double        rate );
 
DLL_EXPORT int daq_request_channel_from_chanlist( daq_t*         daq,
                                                  daq_channel_t* channel );
 
DLL_EXPORT int daq_request_check( daq_t* daq, time_t start, time_t end );
 
DLL_EXPORT int
daq_request_data( daq_t* daq, time_t start, time_t end, time_t dt );
 
DLL_EXPORT int daq_send( daq_t* daq, const char* command );
 
DLL_EXPORT int daq_set_epoch( daq_t* daq, const char* epoch );
 
DLL_EXPORT int daq_startup( void );
 
DLL_EXPORT const char* daq_strerror( int errornum );
 
DLL_EXPORT uint4_type daq_get_block_secs( daq_t* daq );
 
DLL_EXPORT uint4_type daq_get_block_gps( daq_t* daq );
 
DLL_EXPORT uint4_type daq_get_block_gpsn( daq_t* daq );
 
DLL_EXPORT uint4_type daq_get_block_seq_num( daq_t* daq );
 
DLL_EXPORT char* daq_get_block_data( daq_t* daq );
 
#if __cplusplus
}
#endif /* __cplusplus */
 
#endif /* DAQC_H */