mtsCollectorState Class Reference
[Multi Task Support]

#include <mtsCollectorState.h>

Inheritance diagram for mtsCollectorState:

[legend]Collaboration diagram for mtsCollectorState:

Detailed Description

This class provides a way to collect data in the state table without loss and make a log file. The type of a log file can be plain text (ascii), csv, or binary. A state table of which data is to be collected can be specified in the constructor. This is intended for future usage where a task can have more than two state tables.

Definition at line 46 of file mtsCollectorState.h.

Public Member Functions

mtsCollectorState (const std::string &collectorName)
mtsCollectorState (const std::string &targetTaskName, const std::string &targetStateTableName, const CollectorFileFormat fileFormat)
bool SetStateTable (const std::string &taskName, const std::string &stateTableName="")
bool AddSignal (const std::string &signalName="")
void SetSamplingInterval (const unsigned int samplingInterval)
bool Connect (void)
const std::string & GetOutputFileName (void) const

void StartCollection (const mtsDouble &delayInSeconds)
void StopCollection (const mtsDouble &delayInSeconds)

Static Public Member Functions

static bool ConvertBinaryToText (const std::string sourceBinaryLogFileName, const std::string targetPlainTextLogFileName, const char delimiter= ',')

Friends

class mtsCollectorStateTest
class mtsStateTable

Classes

struct SignalElement

Constructor & Destructor Documentation

mtsCollectorState::mtsCollectorState ( const std::string & collectorName )

Constructor using the task name and table name.

mtsCollectorState::mtsCollectorState	(	const std::string &	targetTaskName,
		const std::string &	targetStateTableName,
		const CollectorFileFormat	fileFormat
	)

Constructor using a task pointer and table name.

Member Function Documentation

bool mtsCollectorState::SetStateTable	(	const std::string &	taskName,
		const std::string &	stateTableName = `""`
	)

Defines which table to collect data from. This is defined by the task name and the table name. If the table name is not provided, the collector will use the default task's state table.

bool mtsCollectorState::AddSignal ( const std::string & signalName = "" )

Add the signal specified to a list of registered signals.

void mtsCollectorState::SetSamplingInterval ( const unsigned int samplingInterval ) [inline]

Set a sampling interval so that data collector can skip several values. This is useful when a frequency of the task is somewhat high and you don't want to collect ALL data from it.

Definition at line 160 of file mtsCollectorState.h.

bool mtsCollectorState::Connect ( void )

Connect. Once the state collector has been configured, i.e. the methods SetStateTable and SetOutput have been use, the collector should be added to the manager and then the Connect method should be called.

static bool mtsCollectorState::ConvertBinaryToText	(	const std::string	sourceBinaryLogFileName,
		const std::string	targetPlainTextLogFileName,
		const char	delimiter = `','`
	)			`[static]`

Convert a binary log file into a plain text one.

const std::string& mtsCollectorState::GetOutputFileName ( void ) const [inline]

Get the name of log file currently being written.

Definition at line 176 of file mtsCollectorState.h.

void mtsCollectorState::StartCollection ( const mtsDouble & delayInSeconds ) [virtual]

Methods defined as virtual in base class to control stop/start collection with delay. For the state table collection, these methods are mainly pass through, i.e. they call the corresponding commands from the state table task.

Implements mtsCollectorBase.

void mtsCollectorState::StopCollection ( const mtsDouble & delayInSeconds ) [virtual]