trench_struct Struct Reference

NDS2 trend channel specification. More...

#include <trench.h>

List of all members.

Public Attributes

char * str

size_t len

enum trench_type styp

chantype_t ctype

double rate

Sample rate.

daq_data_t dtype

The type of the channel data.

Detailed Description

NDS2 trend channel specification.

The trench package (structure + functions) implement a standard api to specify and match channel names used by nds2. The channel names may include a trend subchannel name, a sample rate or an nds2 channel type. The general format for channel name to be parsed is:

     <base-name>[.<subchannel>][,<chan-type>][,<rate>]

The package is used by

Create and initialize a trench_struct structure
Preset any known parameters.
Parse the channel name
Extract any needed information from the structure.

A usage example is shown below:

  --  Initialize the trench structure
       trench_struct tch;
       trench_init(&tch);
  --  Preset default channel properties (e.g. channel type, rate, data type)
  --  here.
       tch.ctype = cMTrend;
  --  Parse channel specifier into structure.
       trench_parse(&tch, chanString);