mtsStateTable::DataCollectionInfo Class Reference

#include <mtsStateTable.h>

Public Member Functions
	DataCollectionInfo (void)
	~DataCollectionInfo ()

Public Attributes
bool	Collecting
double	StartTime
double	StopTime
mtsStateTable::IndexRange	BatchRange
size_t	BatchSize
size_t	BatchCounter
size_t	CounterForEvent
double	TimeIntervalForProgressEvent
double	TimeOfLastProgressEvent
mtsFunctionWrite	BatchReady
mtsFunctionVoid	CollectionStarted
mtsFunctionWrite	CollectionStopped
mtsFunctionWrite	Progress

Detailed Description

Data structure used for state table data collection. Stores information related to data collection as well as methods for callbacks

Constructor & Destructor Documentation

mtsStateTable::DataCollectionInfo::DataCollectionInfo ( void  )

inline

Default constructors

mtsStateTable::DataCollectionInfo::~DataCollectionInfo ( )

inline

Member Data Documentation

size_t mtsStateTable::DataCollectionInfo::BatchCounter

Number of elements to be collected so far.

mtsStateTable::IndexRange mtsStateTable::DataCollectionInfo::BatchRange

Range for the batch

mtsFunctionWrite mtsStateTable::DataCollectionInfo::BatchReady

Function used to trigger event sent to state collector when the data collection is needed. The payload is the range defined by state indices.

size_t mtsStateTable::DataCollectionInfo::BatchSize

Maximum number of elements to collect in one batch.

bool mtsStateTable::DataCollectionInfo::Collecting

True if data collection event can be triggered, this state table is currently collecting data (false by default).

mtsFunctionVoid mtsStateTable::DataCollectionInfo::CollectionStarted

Function used to trigger an event when the collection has started

mtsFunctionWrite mtsStateTable::DataCollectionInfo::CollectionStopped

Function used to trigger an event when the collection has stopped

size_t mtsStateTable::DataCollectionInfo::CounterForEvent

Number of elements collected since the last event

mtsFunctionWrite mtsStateTable::DataCollectionInfo::Progress

Function used to trigger an event to indicate progress

double mtsStateTable::DataCollectionInfo::StartTime

Delay in second before data collection should start. This is measured in seconds based on the state table Tic and Toc. 0 means that there is no defined start time.

double mtsStateTable::DataCollectionInfo::StopTime

Delay in second before data collection should stop. This is measured in seconds based on the state table Tic and Toc. 0 means that there is no defined stop time.

double mtsStateTable::DataCollectionInfo::TimeIntervalForProgressEvent

Interval between two progress events (in seconds)

double mtsStateTable::DataCollectionInfo::TimeOfLastProgressEvent

Time of last progress event

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsStateTable.h