ERC CISST - cisst software

---

mtsStateTable::DataCollectionInfo Class Reference

#include <mtsStateTable.h>

Collaboration diagram for mtsStateTable::DataCollectionInfo:

[legend]List of all members.

---

Detailed Description

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

Definition at line 97 of file 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

---

Constructor & Destructor Documentation

mtsStateTable::DataCollectionInfo::DataCollectionInfo

(

void

)

[inline]

Default constructors

Definition at line 148 of file mtsStateTable.h.

---

Member Data Documentation

bool mtsStateTable::DataCollectionInfo::Collecting

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

Definition at line 101 of file mtsStateTable.h.

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.

Definition at line 106 of file mtsStateTable.h.

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.

Definition at line 111 of file mtsStateTable.h.

mtsStateTable::IndexRange mtsStateTable::DataCollectionInfo::BatchRange

Range for the batch

Definition at line 114 of file mtsStateTable.h.

size_t mtsStateTable::DataCollectionInfo::BatchSize

Maximum number of elements to collect in one batch.

Definition at line 117 of file mtsStateTable.h.

size_t mtsStateTable::DataCollectionInfo::BatchCounter

Number of elements to be collected so far.

Definition at line 120 of file mtsStateTable.h.

size_t mtsStateTable::DataCollectionInfo::CounterForEvent

Number of elements collected since the last event

Definition at line 123 of file mtsStateTable.h.

double mtsStateTable::DataCollectionInfo::TimeIntervalForProgressEvent

Interval between two progress events (in seconds)

Definition at line 126 of file mtsStateTable.h.

double mtsStateTable::DataCollectionInfo::TimeOfLastProgressEvent

Time of last progress event

Definition at line 129 of file mtsStateTable.h.

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.

Definition at line 134 of file mtsStateTable.h.

mtsFunctionVoid mtsStateTable::DataCollectionInfo::CollectionStarted

Function used to trigger an event when the collection has started

Definition at line 138 of file mtsStateTable.h.

mtsFunctionWrite mtsStateTable::DataCollectionInfo::CollectionStopped

Function used to trigger an event when the collection has stopped

Definition at line 142 of file mtsStateTable.h.

mtsFunctionWrite mtsStateTable::DataCollectionInfo::Progress

Function used to trigger an event to indicate progress

Definition at line 145 of file mtsStateTable.h.

---

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

• mtsStateTable.h

---