tine.THistory Class Reference

Offers various methods to obtain archived data from both control system servers and central archivers. More...

Classes
class	HstSrc
	Provides specific information concerning the archive source (CENTRAL or LOCAL) used in the archived data acquisition. More...

Static Public Member Functions
static int	GetArchivedData (String context, String server, String property, String device, double start, double stop, Object data, HstSrc src, uint timeout, Boolean extendedRange)
	Gets archived data (trend) for the parameters given over the time range specified. More...
static int	GetArchivedData (String context, String server, String property, String device, int index, int fieldindex, int sample, double start, double stop, Object data, HstSrc src, uint timeout, Boolean extendedRange)
	Gets archived data (trend) for the parameters given over the time range specified. More...
static int	GetArchivedDataSnapshot (String context, String server, String property, String device, [In, Out] double targetTime, Object data, int fieldindex)
	Gets archived data for the parameters given at the time specified More...
static ExclusiveHistorySource	GetExclusiveHistorySource ()
	Gets the current exclusive history source setting More...
static void	SetExclusiveHistorySource (ExclusiveHistorySource value)
	Sets the current exclusive history source setting More...

Detailed Description

Offers various methods to obtain archived data from both control system servers and central archivers.

Member Function Documentation

GetArchivedData() [1/2]

static int tine.THistory.GetArchivedData ( String  context, String  server, String  property, String  device, double  start, double  stop, Object  data, HstSrc  src, uint  timeout, Boolean  extendedRange  )

inlinestatic

Gets archived data (trend) for the parameters given over the time range specified.

Parameters

context	the desired context of the target server
server	the desired target server name. If 'null' then the central archiver is assumed.
property	the desired target property/keyword.
device	the desired target device name (when relevant).
start	is the UTC double timestamp specifying the beginning of the desired archive interval.
stop	is the UTC double timestamp specifying the end of the desired archive interval. If less than 'stop' (e.g. '0') then the current local time will be assumed. If both 'start' and 'stop' are '0' then 'stop' is assumed to be 'now' and 'start' is assumed to be 'now' minus the size of the desired returned data object in seconds.
data	is an object to be filled in by the returned archived data. The object must be an array of a type capable of holding, at the minimum, a value and a timestamp. The minimalist will use an array of DBLDBL objects for a trend of an expected number type vs. time. An array of DBLDBLDBL will return a value number, timestamp, and the stored system stamp (event/cycle number). If the expected type is string-like, then an array of NAME64DBL or NAME64DBLDBL might be used. An array of the HISTORY objects can also be specified, whereby the stored data type (no matter what) will be returned along with all relevant data and time stamps.
src	is a HstSrc object to be filled with information pertinent to the history data source (e.g. the number of points in the time range found in both LOCAL or CENTRAL archives, and which source was used to acquire the archived data.)
timeout	the time out value of the call (default = 1000 msec will be used if .LE. 0 is passed).
extendedRange	if 'true' then an additional 15 minutes will be subtracted from the start time and added to the stop time.

Returns

0 upon success or a TINE error code.

GetArchivedData() [2/2]

static int tine.THistory.GetArchivedData ( String  context, String  server, String  property, String  device, int  index, int  fieldindex, int  sample, double  start, double  stop, Object  data, HstSrc  src, uint  timeout, Boolean  extendedRange  )

inlinestatic

Gets archived data (trend) for the parameters given over the time range specified.

Parameters

context	the desired context of the target server
server	the desired target server name. If 'null' then the central archiver is assumed.
property	the desired target property/keyword.
device	the desired target device name (when relevant).
index	the specific array index if the target record represents an array (default = 0).
fieldindex	the specific field index if the target record is a structure or a compound data type (default = 0).
sample	the desired sampling raster over the time range specified. '0' (default) signals the archiver to find the 'best' raster to accomodate both the time range specified and the size of the data object which is hold the returned archived data. If a specific raster (e.g. '1') is given, then the caller should check the timestamp of the last value in the returned archive data and possibly repeat the call using that value as the new 'start' time.
start	is the UTC double timestamp specifying the beginning of the desired archive interval.
stop	is the UTC double timestamp specifying the end of the desired archive interval. If less than 'stop' (e.g. '0') then the current local time will be assumed. If both 'start' and 'stop' are '0' then 'stop' is assumed to be 'now' and 'start' is assumed to be 'now' minus the size of the desired returned data object in seconds.
data	is an object to be filled in by the returned archived data. The object must be an array of a type capable of holding, at the minimum, a value and a timestamp. The minimalist will use an array of DBLDBL objects for a trend of an expected number type vs. time. An array of DBLDBLDBL will return a value number, timestamp, and the stored system stamp (event/cycle number). If the expected type is string-like, then an array of NAME64DBL or NAME64DBLDBL might be used. An array of the HISTORY objects can also be specified, whereby the stored data type (no matter what) will be returned along with all relevant data and time stamps.
src	is a HstSrc object to be filled with information pertinent to the history data source (e.g. the number of points in the time range found in both LOCAL or CENTRAL archives, and which source was used to acquire the archived data.)
timeout	the time out value of the call (default = 1000 msec will be used if .LE. 0 is passed).
extendedRange	if 'true' then an additional 15 minutes will be subtracted from the start time and added to the stop time.

Returns

0 upon success or a TINE error code.

GetArchivedDataSnapshot()

static int tine.THistory.GetArchivedDataSnapshot ( String  context, String  server, String  property, String  device, [In, Out] double  targetTime, Object  data, int  fieldindex  )

inlinestatic

Gets archived data for the parameters given at the time specified

Parameters

context	the desired context of the target server
server	the desired target server name. If 'null' then the central archiver is assumed.
property	the desired target property/keyword.
device	the desired target device name (when relevant).
targetTime	is the UTC double timestamp specifying the time for which the archive data are desired.
data	is an object to be filled in by the returned archived data.
fieldindex	the specific field index if the target record is a structure or a compound data type (default = 0).

Returns

References tine.TLink.Execute(), tine.TLink.GetCompletionDataSize(), and tine.TLink.GetCompletionDataTimeStamp().

GetExclusiveHistorySource()

static ExclusiveHistorySource tine.THistory.GetExclusiveHistorySource ( )

inlinestatic

Gets the current exclusive history source setting

Returns

the current exclusive history source setting

SetExclusiveHistorySource()

static void tine.THistory.SetExclusiveHistorySource ( ExclusiveHistorySource  value )

inlinestatic

Sets the current exclusive history source setting

Parameters

value

the desired setting

---

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

• tine.cs