Account
|      LibTmsApi 2.3.0         |   
Tms::DataInfo Class Reference
This class defines the data to be acquired and/or fetched. More...
#include <TmsD.h>
Public Member Functions | |
| DataInfo (BUInt32 pcycleNumber=BUInt32(), BUInt32 pchannel=BUInt32(), BUInt32 pcyclePeriod=BUInt32(), BUInt32 pstartTime=BUInt32(), BUInt32 porbitNumber=BUInt32(), BUInt32 pbunchNumber=BUInt32(), BUInt32 pfunction=BUInt32(), BUInt32 pargument=BUInt32(), BUInt32 pnumValues=BUInt32(), BInt32 pbeyondPeriod=BInt32()) | |
Public Attributes | |
| BUInt32 | cycleNumber | 
| The PS Cycle number.   | |
| BUInt32 | channel | 
| The pick-up channel number.   | |
| BUInt32 | cyclePeriod | 
| The cycle period the data is from.   | |
| BUInt32 | startTime | 
| The start time in milli-seconds in the cycle period (starting from 0)   | |
| BUInt32 | orbitNumber | 
| The starting orbit number (starting from 0)   | |
| BUInt32 | bunchNumber | 
| The Bunch number (starting from 1 (0 is all bunches))   | |
| BUInt32 | function | 
| The data processing function to perform or performed. (0 normal data)   | |
| BUInt32 | argument | 
| The Argument to the data processing function.   | |
| BUInt32 | numValues | 
| The total number of data points to return.   | |
| BInt32 | beyondPeriod | 
| If set allows reads of data beyond the end of the period.   | |
Detailed Description
This class defines the data to be acquired and/or fetched.
Constructor & Destructor Documentation
◆ DataInfo()
| Tms::DataInfo::DataInfo | ( | BUInt32 | pcycleNumber = BUInt32(),  |          
| BUInt32 | pchannel = BUInt32(),  |          ||
| BUInt32 | pcyclePeriod = BUInt32(),  |          ||
| BUInt32 | pstartTime = BUInt32(),  |          ||
| BUInt32 | porbitNumber = BUInt32(),  |          ||
| BUInt32 | pbunchNumber = BUInt32(),  |          ||
| BUInt32 | pfunction = BUInt32(),  |          ||
| BUInt32 | pargument = BUInt32(),  |          ||
| BUInt32 | pnumValues = BUInt32(),  |          ||
| BInt32 | pbeyondPeriod = BInt32()  |          ||
| ) | 
Member Data Documentation
◆ argument
| BUInt32 Tms::DataInfo::argument | 
The Argument to the data processing function.
◆ beyondPeriod
| BInt32 Tms::DataInfo::beyondPeriod | 
If set allows reads of data beyond the end of the period.
◆ bunchNumber
| BUInt32 Tms::DataInfo::bunchNumber | 
The Bunch number (starting from 1 (0 is all bunches))
◆ channel
| BUInt32 Tms::DataInfo::channel | 
The pick-up channel number.
◆ cycleNumber
| BUInt32 Tms::DataInfo::cycleNumber | 
The PS Cycle number.
◆ cyclePeriod
| BUInt32 Tms::DataInfo::cyclePeriod | 
The cycle period the data is from.
◆ function
| BUInt32 Tms::DataInfo::function | 
The data processing function to perform or performed. (0 normal data)
◆ numValues
| BUInt32 Tms::DataInfo::numValues | 
The total number of data points to return.
◆ orbitNumber
| BUInt32 Tms::DataInfo::orbitNumber | 
The starting orbit number (starting from 0)
◆ startTime
| BUInt32 Tms::DataInfo::startTime | 
The start time in milli-seconds in the cycle period (starting from 0)
The documentation for this class was generated from the following files:
Generated by
