My Project
 All Classes Files Functions Variables Enumerations Enumerator Friends Macros Pages
gcp::util::RegCal::RegCalData Struct Reference

#include <RegCal.h>

Public Member Functions

bool isEmpty ()
 
void getCalChar (RegDescription *reg, char *data, CoordRange *range=0)
 
void getCalUchar (RegDescription *reg, unsigned char *data, CoordRange *range=0)
 
void getCalUshort (RegDescription *reg, unsigned short *data, CoordRange *range=0)
 
void getCalShort (RegDescription *reg, short *data, CoordRange *range=0)
 
void getCalUint (RegDescription *reg, unsigned *data, CoordRange *range=0)
 
void getCalInt (RegDescription *reg, int *data, CoordRange *range=0)
 
void getCalUlong (RegDescription *reg, unsigned long *data, CoordRange *range=0)
 
void getCalLong (RegDescription *reg, long *data, CoordRange *range=0)
 
void getCalFloat (RegDescription *reg, float *data, CoordRange *range=0)
 
void getCalDouble (RegDescription *reg, double *data, CoordRange *range=0)
 
void getCalDate (RegDescription *reg, gcp::util::RegDate::Data *data, CoordRange *range=0)
 
void getCalComplexFloat (RegDescription *reg, gcp::util::Complex< float >::Data *data, CoordRange *range=0)
 
void getCalFloat (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalDouble (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalUshort (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalShort (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalUint (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalInt (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalChar (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalUchar (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalUlong (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalLong (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalDate (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalComplexFloat (RegDescription *reg, gcp::util::MonitorDataType *data, gcp::util::RegAxisRange &range)
 
void getCalDouble (RegDescription *reg, double *data, RegAxisRange &iRange)
 
void getCalString (RegDescription *reg, char *string, unsigned length)
 
void checkCalArgs (std::string caller, RegDescription *reg, void *data, CoordRange *range=0)
 
 RegCalData (ArrayMap *arrayMap, bool archivedOnly=false)
 

Public Attributes

unsigned nSlot_
 
std::vector< double > slots_
 
bool empty_
 

Detailed Description

The following structure contains a double precision array having the same dimension as an archive frame. calibrate_regdata() returns its results in a container of this type.

Member Function Documentation

void RegCal::RegCalData::checkCalArgs ( std::string  caller,
RegDescription reg,
void *  data,
CoordRange range = 0 
)

....................................................................... This is an argument validation function used by the get_cal_...() functions.

Input: caller char * The name of the calling function. cal RegCalData * The calibrated frame of selected registers. reg ArrRegMapReg * The register-range specification that was used to select the required register for monitoring. index unsigned The first index of the register that is to be returned. n unsigned The number of register elements to return. *reg must cover all elements in the index range index..index+n-1. Input/Output: data void * The output array. Output: return int 0 - OK. 1 - Error.

void RegCal::RegCalData::getCalString ( RegDescription reg,
char *  string,
unsigned  length 
)

....................................................................... Unpack a string from a calibrated register frame.

Input: cal RegCalData * The calibrated frame of selected registers. reg ArrRegMapReg * The register-range specification that was used to select the required register for monitoring. length unsigned The max number of characters to be placed in data (including the '\0' terminator). Input/Output: string char * The array of nc characters to return the string in. Output: return int 0 - OK. 1 - Error.


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