trench_struct Struct Reference

NDS2 trend channel specification. More...

#include <trench.h>

Public Attributes
char *	str
size_t	len
enum trench_type	styp
chantype_t	ctype
double	rate
	Sample rate. More...
daq_data_t	dtype
	The type of the channel data. More...

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);

Author

John. Zweizig

Version

1.0; Last modified May 3, 2010

Member Data Documentation

chantype_t trench_struct::ctype

NDS2 channel type.

daq_data_t trench_struct::dtype

The type of the channel data.

The data type field defaults to -undefined and may be inferred from the channel subtype if the channel is a trend

size_t trench_struct::len

Length of channel base name.

double trench_struct::rate

Sample rate.

The sample rate is valid only if it is specified explicitly or inferred from the channel type. Othewise rate = 0;

char* trench_struct::str

Full channel name string.

enum trench_type trench_struct::styp

Trend channel subtype (statistic).

---

The documentation for this struct was generated from the following file:

• src/client/trench.h