#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

◆ DataCollectionInfo()

mtsStateTable::DataCollectionInfo::DataCollectionInfo ( void )

inline

Default constructors

◆ ~DataCollectionInfo()

mtsStateTable::DataCollectionInfo::~DataCollectionInfo ( )

inline

Member Data Documentation

◆ BatchCounter

size_t mtsStateTable::DataCollectionInfo::BatchCounter

Number of elements to be collected so far.

◆ BatchRange

mtsStateTable::IndexRange mtsStateTable::DataCollectionInfo::BatchRange

Range for the batch

◆ BatchReady

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.

◆ BatchSize

size_t mtsStateTable::DataCollectionInfo::BatchSize

Maximum number of elements to collect in one batch.

◆ Collecting

bool mtsStateTable::DataCollectionInfo::Collecting

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

◆ CollectionStarted

mtsFunctionVoid mtsStateTable::DataCollectionInfo::CollectionStarted

Function used to trigger an event when the collection has started

◆ CollectionStopped

mtsFunctionWrite mtsStateTable::DataCollectionInfo::CollectionStopped

Function used to trigger an event when the collection has stopped

◆ CounterForEvent

size_t mtsStateTable::DataCollectionInfo::CounterForEvent

Number of elements collected since the last event

◆ Progress

mtsFunctionWrite mtsStateTable::DataCollectionInfo::Progress

Function used to trigger an event to indicate progress

◆ StartTime

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.

◆ StopTime

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.

◆ TimeIntervalForProgressEvent

double mtsStateTable::DataCollectionInfo::TimeIntervalForProgressEvent

Interval between two progress events (in seconds)

◆ TimeOfLastProgressEvent

double mtsStateTable::DataCollectionInfo::TimeOfLastProgressEvent

Time of last progress event

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

tmp/cisst-saw/cisst/cisstMultiTask/mtsStateTable.h

Public Member Functions

Public Attributes