cisst-saw
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
mtsCollectorBase Class Referenceabstract

#include <mtsCollectorBase.h>

Inheritance diagram for mtsCollectorBase:
mtsTaskFromSignal mtsTaskContinuous mtsTask mtsComponent cmnGenericObject mtsCollectorEvent mtsCollectorState

Classes

class  SignalMapElement
 

Public Types

enum  CollectorFileFormat { COLLECTOR_FILE_FORMAT_PLAIN_TEXT, COLLECTOR_FILE_FORMAT_BINARY, COLLECTOR_FILE_FORMAT_CSV, COLLECTOR_FILE_FORMAT_UNDEFINED }
 
enum  CollectorFileFloatingNotation { COLLECTOR_FILE_FLOATING_NOTATION_NONE, COLLECTOR_FILE_FLOATING_NOTATION_FIXED, COLLECTOR_FILE_FLOATING_NOTATION_SCIENTIFIC }
 
- Public Types inherited from mtsTaskContinuous
typedef mtsTask BaseType
 
- Public Types inherited from mtsTask
typedef mtsComponent BaseType
 
- Public Types inherited from mtsComponent
typedef mtsComponent ThisType
 

Public Member Functions

 mtsCollectorBase (const std::string &collectorName, const CollectorFileFormat fileFormat)
 
virtual ~mtsCollectorBase (void)
 
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 CloseOutput (void)
 
const std::string & GetOutputFileName (void) const
 
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
 
void SetOutputStreamFloatingNotation (const CollectorFileFloatingNotation floatingNotation)
 
void SetOutputStreamPrecision (const int precision)
 
void SetOutputStreamWidth (const int width)
 
void SetOutputStreamFill (const char fillCharacter)
 
- Public Member Functions inherited from mtsTaskFromSignal
 mtsTaskFromSignal (const std::string &name, unsigned int sizeStateTable=256)
 
virtual ~mtsTaskFromSignal ()
 
void Kill (void)
 
mtsInterfaceRequiredAddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED)
 
mtsInterfaceProvidedAddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)
 
- Public Member Functions inherited from mtsTaskContinuous
 mtsTaskContinuous (const std::string &name, unsigned int sizeStateTable=256, bool newThread=true)
 
 mtsTaskContinuous (const mtsTaskContinuousConstructorArg &arg)
 
virtual ~mtsTaskContinuous ()
 
void Create (void *data=0)
 
void Start (void)
 
void Suspend (void)
 
- Public Member Functions inherited from mtsTask
 mtsTask (const std::string &name, unsigned int sizeStateTable=256)
 
virtual ~mtsTask ()
 
virtual void OnStartupException (const std::exception &excp)
 
virtual void Run (void)=0
 
virtual void OnRunException (const std::exception &excp)
 
virtual void Configure (const std::string &CMN_UNUSED(filename)="")
 
void SetInitializationDelay (double delay)
 
void Create (void)
 
double GetAveragePeriod (void) const
 
const std::string GetDefaultStateTableName (void) const
 
mtsStateTableGetDefaultStateTable (void)
 
virtual bool WaitToStart (double timeout)
 
virtual bool WaitToTerminate (double timeout)
 
virtual void WaitForWakeup (void)
 
virtual void Wakeup (void)
 
void ProcessManagerCommandsIfNotActive ()
 
bool CheckForOwnThread (void) const
 
virtual bool IsPeriodic (void) const
 
virtual bool IsOverranPeriod (void) const
 
virtual void ResetOverranPeriod (void)
 
- Public Member Functions inherited from mtsComponent
 mtsComponent (const std::string &deviceName)
 
virtual ~mtsComponent ()
 
const std::string & GetName (void) const
 
void GetName (std::string &placeHolder) const
 
void SetName (const std::string &componentName)
 
virtual void Configure (const std::string &filename="")
 
bool CreateAndWait (double timeoutInSeconds)
 
bool StartAndWait (double timeoutInSeconds)
 
bool KillAndWait (double timeoutInSeconds)
 
mtsInterfaceProvidedAddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)
 
CISST_DEPRECATED
mtsInterfaceProvided
AddProvidedInterface (const std::string &interfaceProvidedName)
 
virtual mtsInterfaceOutputAddInterfaceOutput (const std::string &interfaceOutputName)
 
bool InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
bool InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
bool InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const
 
mtsInterfaceProvidedGetInterfaceProvided (const std::string &interfaceProvidedName) const
 
mtsInterfaceOutputGetInterfaceOutput (const std::string &interfaceOutputName) const
 
size_t GetNumberOfInterfacesProvided (void) const
 
size_t GetNumberOfInterfacesOutput (void) const
 
bool RemoveInterfaceProvided (const std::string &interfaceProvidedName, const bool skipDisconnect=false)
 
mtsInterfaceRequiredAddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
 
CISST_DEPRECATED
mtsInterfaceRequired
AddRequiredInterface (const std::string &requiredInterfaceName)
 
virtual mtsInterfaceInputAddInterfaceInput (const std::string &interfaceInputName)
 
const mtsInterfaceProvidedGetInterfaceProvidedFor (const std::string &interfaceRequiredName)
 
mtsInterfaceRequiredGetInterfaceRequired (const std::string &interfaceRequiredName)
 
mtsInterfaceInputGetInterfaceInput (const std::string &interfaceInputName) const
 
size_t GetNumberOfInterfacesRequired (void) const
 
size_t GetNumberOfInterfacesInput (void) const
 
bool RemoveInterfaceRequired (const std::string &interfaceRequiredName, const bool skipDisconnect=false)
 
const mtsManagerComponentServicesGetManagerComponentServices (void) const
 
mtsManagerComponentServicesGetManagerComponentServices (void)
 
mtsStateTableGetStateTable (const std::string &stateTableName)
 
bool AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)
 
void UseSeparateLogFileDefault (bool forwardToLogger=true)
 
void UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)
 
void UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)
 
cmnLogger::StreamBufTypeGetLogMultiplexer (void) const
 
bool IsRunning (void) const
 
bool CISST_DEPRECATED Running (void) const
 
bool IsStarted (void) const
 
bool IsTerminated (void) const
 
bool IsEndTask (void) const
 
const mtsComponentStateGetState (void) const
 
void GetState (mtsComponentState &state) const
 
void ToStream (std::ostream &outputStream) const
 
bool SetReplayMode (void)
 
bool SetReplayData (const std::string &stateTableName, const std::string &fileName)
 
bool SetReplayTime (const double time)
 
std::vector< std::string > GetNamesOfInterfacesProvidedOrOutput (void) const
 
std::vector< std::string > GetNamesOfInterfacesProvided (void) const
 
std::vector< std::string > GetNamesOfInterfacesOutput (void) const
 
std::vector< std::string > GetNamesOfInterfacesRequiredOrInput (void) const
 
std::vector< std::string > GetNamesOfInterfacesRequired (void) const
 
std::vector< std::string > GetNamesOfInterfacesInput (void) const
 
- Public Member Functions inherited from cmnGenericObject
virtual ~cmnGenericObject (void)
 
virtual const
cmnClassServicesBase
Services (void) const =0
 
bool ReconstructFrom (const cmnGenericObject &other)
 
std::string ToString (void) const
 
virtual void ToStreamRaw (std::ostream &outputStream, const char delimiter= ' ', bool headerOnly=false, const std::string &headerPrefix="") const
 
virtual bool FromStreamRaw (std::istream &inputStream, const char delimiter= ' ')
 
virtual void SerializeRaw (std::ostream &outputStream) const
 
virtual void DeSerializeRaw (std::istream &inputStream)
 
virtual size_t ScalarNumber (void) const
 
virtual bool ScalarNumberIsFixed (void) const
 
virtual double Scalar (const size_t CMN_UNUSED(index)) const throw (std::out_of_range)
 
virtual std::string ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const
 

Public Attributes

mtsFunctionVoid CollectionStartedEventTrigger
 
mtsFunctionWrite CollectionStoppedEventTrigger
 
mtsFunctionWrite ProgressEventTrigger
 

Protected Types

enum  CollectorStatus { COLLECTOR_STOP, COLLECTOR_WAIT_START, COLLECTOR_COLLECTING, COLLECTOR_WAIT_STOP }
 
typedef cmnNamedMap
< SignalMapElement
SignalMapType
 
typedef cmnNamedMap
< SignalMapType
TaskMapType
 
- Protected Types inherited from mtsTaskFromSignal
typedef mtsTaskContinuous BaseType
 
- Protected Types inherited from mtsComponent
typedef cmnNamedMap
< mtsStateTable
StateTableMapType
 
typedef cmnNamedMap
< mtsInterfaceProvided
InterfacesProvidedMapType
 
typedef cmnNamedMap
< mtsInterfaceOutput
InterfacesOutputMapType
 
typedef cmnNamedMap
< mtsInterfaceRequired
InterfacesRequiredMapType
 
typedef cmnNamedMap
< mtsInterfaceInput
InterfacesInputMapType
 

Protected Member Functions

void SetDelimiter (void)
 
void SetOutputStreamParams (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 Member Functions inherited from mtsTaskFromSignal
void * RunInternal (void *argument)
 
void PostCommandQueuedMethod (void)
 
- Protected Member Functions inherited from mtsTaskContinuous
virtual void StartInternal (void)
 
- Protected Member Functions inherited from mtsTask
void RunEventHandler (void)
 
void ChangeStateEventHandler (const mtsComponentState &newState)
 
mtsExecutionResult RunEvent (bool check=true)
 
void DoRunInternal (void)
 
virtual void StartupInternal (void)
 
virtual void CleanupInternal (void)
 
void Sleep (double timeInSeconds)
 
mtsStateIndex::TimeTicksType GetTick (void) const
 
virtual void SaveThreadStartData (void *data)
 
virtual void SetThreadReturnValue (void *returnValue)
 
void ChangeState (mtsComponentState::Enum newState)
 
bool WaitForState (mtsComponentState desiredState, double timeout)
 
- Protected Member Functions inherited from mtsComponent
 mtsComponent (void)
 
 mtsComponent (const mtsComponent &other)
 
void Initialize (void)
 
mtsInterfaceRequiredAddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)
 
mtsInterfaceRequiredAddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)
 
mtsInterfaceProvidedAddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)
 
mtsInterfaceInputAddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)
 
mtsInterfaceOutputAddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)
 
void KillSeparateLogFile (void)
 
size_t ProcessMailBoxes (InterfacesProvidedMapType &interfaces)
 
size_t ProcessQueuedCommands (void)
 
size_t ProcessQueuedEvents (void)
 
mtsInterfaceRequiredEnableDynamicComponentManagement (void)
 Enable support for dynamic component management services. More...
 
bool AddInterfaceInternal (const bool useMangerComponentServices=false)
 Add internal interfaces. More...
 
void InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
 
void InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
 
void InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)
 
void InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)
 
void InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)
 
void InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)
 

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
 
std::string OutputHeaderFileName
 
mtsStdString WorkingDirectoryMember
 
std::ostream * OutputStream
 
std::ofstream * OutputFile
 
std::ostream * OutputHeaderStream
 
std::ofstream * OutputHeaderFile
 
CollectorFileFloatingNotation FloatingNotation
 
std::streamsize Precision
 
std::streamsize Width
 
char FillCharacter
 
bool FileOpened
 
char Delimiter
 
std::stringstream StringStreamBufferForSerialization
 
cmnSerializerSerializer
 
mtsInterfaceProvidedControlInterface
 
- Protected Attributes inherited from mtsTaskFromSignal
mtsCallableVoidBasePostCommandQueuedCallable
 
- Protected Attributes inherited from mtsTaskContinuous
bool NewThread
 
bool CaptureThread
 
- Protected Attributes inherited from mtsTask
osaThread Thread
 
double InitializationDelay
 
osaMutex StateChange
 
osaThreadSignal StateChangeSignal
 
mtsStateTable StateTable
 
bool OverranPeriod
 
void * ThreadStartData
 
void * ReturnValue
 
mtsCallableVoidBaseInterfaceProvidedToManagerCallable
 
mtsInterfaceRequiredExecIn
 
mtsInterfaceProvidedExecOut
 
mtsFunctionVoid RunEventInternal
 
bool RunEventCalled
 
mtsFunctionWrite ChangeStateEvent
 
- Protected Attributes inherited from mtsComponent
std::string Name
 
mtsComponentState State
 
mtsInterfaceProvidedInterfaceProvidedToManager
 
bool UseSeparateLogFileFlag
 
cmnLogger::StreamBufTypeLoDMultiplexerStreambuf
 
std::ofstream * LogFile
 
StateTableMapType StateTables
 
mtsManagerComponentServicesManagerComponentServices
 
mtsFunctionWrite EventGeneratorChangeState
 
bool ReplayMode
 
InterfacesProvidedMapType InterfacesProvided
 
InterfacesOutputMapType InterfacesOutput
 
InterfacesRequiredMapType InterfacesRequired
 
InterfacesInputMapType InterfacesInput
 

Static Protected Attributes

static mtsComponentManagerComponentManager
 

Friends

class mtsCollectorBaseTest
 

Additional Inherited Members

- Static Public Attributes inherited from mtsTask
static std::runtime_error UnknownException
 

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.

Member Typedef Documentation

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

Member Enumeration Documentation

Enumerator
COLLECTOR_FILE_FLOATING_NOTATION_NONE 
COLLECTOR_FILE_FLOATING_NOTATION_FIXED 
COLLECTOR_FILE_FLOATING_NOTATION_SCIENTIFIC 
Enumerator
COLLECTOR_FILE_FORMAT_PLAIN_TEXT 
COLLECTOR_FILE_FORMAT_BINARY 
COLLECTOR_FILE_FORMAT_CSV 
COLLECTOR_FILE_FORMAT_UNDEFINED 

State definition of the collector

Enumerator
COLLECTOR_STOP 
COLLECTOR_WAIT_START 
COLLECTOR_COLLECTING 
COLLECTOR_WAIT_STOP 

Constructor & Destructor Documentation

mtsCollectorBase::mtsCollectorBase ( const std::string &  collectorName,
const CollectorFileFormat  fileFormat 
)
virtual mtsCollectorBase::~mtsCollectorBase ( void  )
virtual

Member Function Documentation

void mtsCollectorBase::Cleanup ( void  )
protectedvirtual

Clean up internal data.

Reimplemented from mtsComponent.

void mtsCollectorBase::ClearTaskMap ( void  )
protected

Clear TaskMap

void mtsCollectorBase::CloseOutput ( void  )

Closes the output file stream

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

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

Implemented in mtsCollectorEvent.

const std::string& mtsCollectorBase::GetOutputFileName ( void  ) const
inline

Get the name of log file currently being written.

void mtsCollectorBase::GetWorkingDirectory ( mtsStdString placeHolder) const

Get working directory, usable with commands as well

void mtsCollectorBase::Init ( void  )
protected

Initialize this collector instance

void mtsCollectorBase::OpenFileIfNeeded ( void  )

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

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::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, and the floating point notation will be COLLECTOR_FILE_FLOATING_NOTATION_NONE otherwise it will use the previously used format.

void mtsCollectorBase::SetOutputStreamFill ( const char  fillCharacter)

Set fill character for the output file. This setting will apply to all future files.

void mtsCollectorBase::SetOutputStreamFloatingNotation ( const CollectorFileFloatingNotation  floatingNotation)

Set floating point notation for the output stream. This setting will apply to all future files opened.

void mtsCollectorBase::SetOutputStreamParams ( void  )
protected

Setup the parameters for the collector output stream.

void mtsCollectorBase::SetOutputStreamPrecision ( const int  precision)

Set precision value for the output file. This setting will apply to all future files.

void mtsCollectorBase::SetOutputStreamWidth ( const int  width)

Set width value for the output file. This setting will apply to all future files.

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. Uses the default floating point notation COLLECTOR_FILE_FLOATING_NOTATION_NONE

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, and the floating point notation would be COLLECTOR_FILE_FLOATING_NOTATION_NONE, otherwise it will use the previously used format.

void mtsCollectorBase::SetupControlInterface ( void  )
protected

Create the provided interface for control.

void mtsCollectorBase::SetWorkingDirectory ( const mtsStdString directory)

Set working directory, usable with commands as well

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'.

Implemented in mtsCollectorEvent, and mtsCollectorState.

void mtsCollectorBase::StartCollectionCommand ( void  )
inlineprotected

Methods used to populate the component provided interface.

void mtsCollectorBase::StartCollectionInCommand ( const mtsDouble delayInSeconds)
inlineprotected
virtual void mtsCollectorBase::Startup ( void  )
protectedpure virtual

Set some initial values

Reimplemented from mtsComponent.

Implemented in mtsCollectorEvent.

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'.

Implemented in mtsCollectorEvent, and mtsCollectorState.

void mtsCollectorBase::StopCollectionCommand ( void  )
inlineprotected
void mtsCollectorBase::StopCollectionInCommand ( const mtsDouble delayInSeconds)
inlineprotected

Friends And Related Function Documentation

friend class mtsCollectorBaseTest
friend

Member Data Documentation

mtsFunctionVoid mtsCollectorBase::CollectionStartedEventTrigger

Function used to trigger Collection Started event.

mtsFunctionWrite mtsCollectorBase::CollectionStoppedEventTrigger

Function used to trigger Collection Started event.

mtsComponentManager* mtsCollectorBase::ComponentManager
staticprotected

Static member variables

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, ...

mtsInterfaceProvided* mtsCollectorBase::ControlInterface
protected

Default control interface and methods used for the provided commands.

char mtsCollectorBase::Delimiter
protected

Delimiter used in a log file. Set by the constructor according to mtsCollectorBase::CollectorLogFormat.

CollectorFileFormat mtsCollectorBase::FileFormat
protected
bool mtsCollectorBase::FileOpened
protected

Check if the output file is already opened

char mtsCollectorBase::FillCharacter
protected

Collector File fill value [DEFAULT = ' ']

bool mtsCollectorBase::FirstRunningFlag
protected

Flag for PrintHeader() method.

CollectorFileFloatingNotation mtsCollectorBase::FloatingNotation
protected

Collector File floating notation enum, default is COLLECTOR_FILE_FLOATING_NOTATION_NONE

std::ofstream* mtsCollectorBase::OutputFile
protected
std::string mtsCollectorBase::OutputFileName
protected

Output file name, including working directory.

std::ofstream* mtsCollectorBase::OutputHeaderFile
protected
std::string mtsCollectorBase::OutputHeaderFileName
protected
std::ostream* mtsCollectorBase::OutputHeaderStream
protected
std::ostream* mtsCollectorBase::OutputStream
protected

Pointer on output stream, can be create and managed by this class or provided by a user.

std::streamsize mtsCollectorBase::Precision
protected

Collector File precision [DEFAULT = 10] This is the maximum number of characters used.

mtsFunctionWrite mtsCollectorBase::ProgressEventTrigger

Function used to trigger Progress event.

unsigned int mtsCollectorBase::SampleCounter
protected

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

unsigned int mtsCollectorBase::SampleCounterForEvent
protected

Counter for number of sample since the last CollectionStopped event

cmnSerializer* mtsCollectorBase::Serializer
protected

Serializer for binary logging. DeSerializer is used only at ConvertBinaryToText() method so we don't define it here.

CollectorStatus mtsCollectorBase::Status
protected
std::stringstream mtsCollectorBase::StringStreamBufferForSerialization
protected

String stream buffer for serialization.

TaskMapType mtsCollectorBase::TaskMap
protected
double mtsCollectorBase::TimeIntervalForProgressEvent
protected

Interval between two progress events (in seconds)

double mtsCollectorBase::TimeOfLastProgressEvent
protected

Time of last progress event

std::streamsize mtsCollectorBase::Width
protected

Collector File width [DEFAULT = 4] This is the minimum number of characters used.

mtsStdString mtsCollectorBase::WorkingDirectoryMember
protected

Current directory to save data


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