HistorySpecification Struct Reference

Defines a TINE History Specification object. More...

#include <hstlib.h>

Data Fields
int	archiveRate
float	aTolerance
int	depthLong
int	depthShort
int	heartbeat
int	pollingRate
float	pTolerance
char *	rhsPropertyName
char *	rhsServerName

Detailed Description

Defines a TINE History Specification object.

Note

the pTolerance (relative or percent) field below is the multiplication factor applied to the last archived data and is so incorprated into the tolerance. As such it should be a value between 0 and 1 (i.e. '.1' is 10 %). Values greater than 1 are automatically divided by 100 % (the assumption being the the caller was thinking in units of '') and the ensuing fractional number will be seen in any queries and cache files.

Field Documentation

archiveRate

int HistorySpecification::archiveRate

archive rate in msec

aTolerance

float HistorySpecification::aTolerance

absolute tolerance

depthLong

int HistorySpecification::depthLong

for long term storage

depthShort

int HistorySpecification::depthShort

for short term storage

heartbeat

int HistorySpecification::heartbeat

archive heartbeat in sec

pollingRate

int HistorySpecification::pollingRate

polling rate in msec

pTolerance

float HistorySpecification::pTolerance

relative (percent) tolerance

rhsPropertyName

char* HistorySpecification::rhsPropertyName

Remote Property Name

rhsServerName

char* HistorySpecification::rhsServerName

Remote Server Name

---

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

• hstlib.h