mtsCollectorBase Class Reference
[Multi Task Support]

#include <mtsCollectorBase.h>

Inheritance diagram for mtsCollectorBase:

[legend]Collaboration diagram for mtsCollectorBase:

Detailed Description

This class provides a way to collect data from state table in real-time. Collected data can be either saved as a log file or displayed in GUI like an oscilloscope.

Definition at line 51 of file mtsCollectorBase.h.

Public Types

enum CollectorFileFormat

Public Member Functions

mtsCollectorBase (const std::string &collectorName, const CollectorFileFormat fileFormat)
virtual std::string GetDefaultOutputName (void)=0
void SetOutput (const std::string &fileName, const CollectorFileFormat fileFormat)
void SetOutput (std::ostream &outputStream, const CollectorFileFormat fileFormat)
void SetOutput (std::ostream &outputStream)
void SetOutputToDefault (const CollectorFileFormat fileFormat)
void SetOutputToDefault (void)
void OpenFileIfNeeded (void)
virtual void StartCollection (const mtsDouble &delayInSeconds)=0
virtual void StopCollection (const mtsDouble &delayInSeconds)=0
void SetWorkingDirectory (const mtsStdString &directory)
void GetWorkingDirectory (mtsStdString &placeHolder) const

Public Attributes

Protected Types

enum CollectorStatus
typedef cmnNamedMap< SignalMapElement > SignalMapType
typedef cmnNamedMap< SignalMapType > TaskMapType

Protected Member Functions

void SetDelimiter (void)
void StartCollectionCommand (void)
void StartCollectionInCommand (const mtsDouble &delayInSeconds)
void StopCollectionCommand (void)
void StopCollectionInCommand (const mtsDouble &delayInSeconds)
void Init (void)
void Cleanup (void)
void ClearTaskMap (void)
virtual void Startup (void)=0
void SetupControlInterface (void)

Protected Attributes

CollectorStatus Status
CollectorFileFormat FileFormat
TaskMapType TaskMap
bool ConnectedFlag
bool FirstRunningFlag
unsigned int SampleCounter
unsigned int SampleCounterForEvent
double TimeIntervalForProgressEvent
double TimeOfLastProgressEvent
std::string OutputFileName
mtsStdString WorkingDirectoryMember
std::ostream * OutputStream
std::ofstream * OutputFile
bool FileOpened
char Delimiter
std::stringstream StringStreamBufferForSerialization
cmnSerializer * Serializer
mtsInterfaceProvided * ControlInterface

Static Protected Attributes

static mtsTaskManager * TaskManager

Friends

class mtsCollectorBaseTest

Classes

class SignalMapElement

Member Typedef Documentation

typedef cmnNamedMap<SignalMapElement> mtsCollectorBase::SignalMapType [protected]

Container definition for tasks and signals. TaskMap: (taskName, SignalMap*) SignalMap: (SignalName, SignalMapElement)

Definition at line 91 of file mtsCollectorBase.h.

Member Enumeration Documentation

enum mtsCollectorBase::CollectorStatus [protected]

State definition of the collector

Definition at line 68 of file mtsCollectorBase.h.

Member Function Documentation

void mtsCollectorBase::SetDelimiter ( void ) [protected]

Update the delimiter used in output files based on file format. Should be used everytime FileFormat is set.

void mtsCollectorBase::StartCollectionCommand ( void ) [inline, protected]

Methods used to populate the component provided interface.

Definition at line 151 of file mtsCollectorBase.h.

void mtsCollectorBase::Init ( void ) [protected]

Initialize this collector instance

void mtsCollectorBase::Cleanup ( void ) [protected, virtual]

Clean up internal data.

Reimplemented from mtsTask.

void mtsCollectorBase::ClearTaskMap ( void ) [protected]

Clear TaskMap

virtual void mtsCollectorBase::Startup ( void ) [protected, pure virtual]

Set some initial values

Reimplemented from mtsTask.

void mtsCollectorBase::SetupControlInterface ( void ) [protected]

Create the provided interface for control.

virtual std::string mtsCollectorBase::GetDefaultOutputName ( void ) [pure virtual]

Generate default file name, without the prefix (txt, csv, cdat)

void mtsCollectorBase::SetOutput	(	const std::string &	fileName,
		const CollectorFileFormat	fileFormat
	)

Define the output file and format. If a file is already in use, this method will close the current one.

void mtsCollectorBase::SetOutput	(	std::ostream &	outputStream,
		const CollectorFileFormat	fileFormat
	)

Define the output using an existing ostream, the collector will not open nor close the stream.

void mtsCollectorBase::SetOutput ( std::ostream & outputStream )

Define the output using an existing ostream, the collector will not open nor close the stream. If this method is called for the first time, the format will be COLLECTOR_FILE_FORMAT_CSV, otherwise it will use the previously used format.

void mtsCollectorBase::SetOutputToDefault ( const CollectorFileFormat fileFormat )

Creates a default file name using the task name, table name and date. The suffix depends on the file format.

void mtsCollectorBase::SetOutputToDefault ( void )

Creates a default file name using the task name, table name and date. If this method is called for the first time, the format will be COLLECTOR_FILE_FORMAT_CSV, otherwise it will use the previously used format.

void mtsCollectorBase::OpenFileIfNeeded ( void )

Files are not created or opened when SetOutput is called, this method will open the file if needed.

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

Begin collecting data. Data collection will begin after delayedStart second(s). If it is zero (by default), it means 'start now'.

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

End collecting data. Data collection will end after delayedStop second(s). If it is zero (by default), it means 'stop now'.

void mtsCollectorBase::SetWorkingDirectory ( const mtsStdString & directory )

Set working directory, usable with commands as well

void mtsCollectorBase::GetWorkingDirectory ( mtsStdString & placeHolder ) const

Get working directory, usable with commands as well

Member Data Documentation

mtsTaskManager* mtsCollectorBase::TaskManager [static, protected]

Static member variables

Definition at line 96 of file mtsCollectorBase.h.

bool mtsCollectorBase::ConnectedFlag [protected]

Flag to determine if the collector is connected. Once the collector is connected, it becomes impossible to change the observed state table, components, ...

Definition at line 101 of file mtsCollectorBase.h.

bool mtsCollectorBase::FirstRunningFlag [protected]

Flag for PrintHeader() method.

Definition at line 104 of file mtsCollectorBase.h.

unsigned int mtsCollectorBase::SampleCounter [protected]

Counter for number of samples since the output has been set.

Definition at line 107 of file mtsCollectorBase.h.

unsigned int mtsCollectorBase::SampleCounterForEvent [protected]

Counter for number of sample since the last CollectionStopped event

Definition at line 110 of file mtsCollectorBase.h.

double mtsCollectorBase::TimeIntervalForProgressEvent [protected]

Interval between two progress events (in seconds)