#include <mtsCollectorBase.h>

Inheritance diagram for mtsCollectorBase:

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)
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)
virtual void	SetOutputToDefault (void)
void	CloseOutput (void)
const std::string &	GetOutputFileName (void) const
void	OpenFileIfNeeded (void)
virtual void	StartCollection (const double &delayInSeconds)=0
virtual void	StopCollection (const double &delayInSeconds)=0
virtual void	SetWorkingDirectory (const std::string &directory)
void	GetWorkingDirectory (std::string &placeHolder) const
void	SetOutputStreamFloatingNotation (const CollectorFileFloatingNotation floatingNotation)
void	SetOutputStreamPrecision (const int precision)
void	SetOutputStreamWidth (const int width)
void	SetOutputStreamFill (const char fillCharacter)
virtual bool	Connect (void)=0
Public Member Functions inherited from mtsTaskFromSignal
	mtsTaskFromSignal (const std::string &name, unsigned int sizeStateTable=256)
	mtsTaskFromSignal (const mtsTaskConstructorArg &arg)
virtual	~mtsTaskFromSignal ()
void	Kill (void) override
mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED) override
mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY) override
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) override
void	Start (void) override
void	Suspend (void) override
virtual bool	CreatesThread (void) const
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)
void	Configure (const std::string &CMN_UNUSED(filename)="") override
void	SetInitializationDelay (double delay)
void	Create (void) override
double	GetAveragePeriod (void) const
const std::string	GetDefaultStateTableName (void) const
mtsStateTable *	GetDefaultStateTable (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	AddTag (const std::string &tag)
const std::set< std::string > &	GetTags (void) 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)
virtual void	Startup (void)
mtsInterfaceProvided *	AddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)
CISST_DEPRECATED mtsInterfaceProvided *	AddProvidedInterface (const std::string &interfaceProvidedName)
virtual mtsInterfaceOutput *	AddInterfaceOutput (const std::string &interfaceOutputName)
std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const
std::vector< std::string >	GetNamesOfInterfacesProvided (void) const
std::vector< std::string >	GetNamesOfInterfacesOutput (void) const
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
mtsInterfaceProvided *	GetInterfaceProvided (const std::string &interfaceProvidedName) const
mtsInterfaceOutput *	GetInterfaceOutput (const std::string &interfaceOutputName) const
size_t	GetNumberOfInterfacesProvided (void) const
size_t	GetNumberOfInterfacesOutput (void) const
bool	RemoveInterfaceProvided (const std::string &interfaceProvidedName)
mtsInterfaceRequired *	AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)
CISST_DEPRECATED mtsInterfaceRequired *	AddRequiredInterface (const std::string &requiredInterfaceName)
virtual mtsInterfaceInput *	AddInterfaceInput (const std::string &interfaceInputName)
std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const
std::vector< std::string >	GetNamesOfInterfacesRequired (void) const
std::vector< std::string >	GetNamesOfInterfacesInput (void) const
const mtsInterfaceProvided *	GetInterfaceProvidedFor (const std::string &interfaceRequiredName)
mtsInterfaceRequired *	GetInterfaceRequired (const std::string &interfaceRequiredName)
mtsInterfaceInput *	GetInterfaceInput (const std::string &interfaceInputName) const
size_t	GetNumberOfInterfacesRequired (void) const
size_t	GetNumberOfInterfacesInput (void) const
bool	RemoveInterfaceRequired (const std::string &interfaceRequiredName)
mtsStateTable *	GetStateTable (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::StreamBufType *	GetLogMultiplexer (void) const override
bool	AreAllInterfacesRequiredConnected (const bool log=false)
bool	IsRunning (void) const
bool CISST_DEPRECATED	Running (void) const
bool	IsStarted (void) const
bool	IsTerminated (void) const
bool	IsEndTask (void) const
const mtsComponentState &	GetState (void) const
void	GetState (mtsComponentState &state) const
void	ToStream (std::ostream &outputStream) const override
bool	SetReplayMode (void)
bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)
bool	SetReplayTime (const double time)
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 CISST_THROW(std
virtual std::string	ScalarDescription (const size_t CMN_UNUSED(index), const std::string &CMN_UNUSED(userDescription)) const

Public Attributes
mtsFunctionWrite	CollectionStartedEventTrigger
mtsFunctionWrite	ProgressEventTrigger

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

Protected Member Functions
void	SetDelimiter (void)
void	SetOutputStreamParams (void)
void	StartCollectionCommand (const double &delayInSeconds)
void	StopCollectionCommand (const double &delayInSeconds)
void	SetWorkingDirectoryCommand (const std::string &directory)
void	SetOutputToDefaultCommand (void)
void	Init (void)
void	Cleanup (void)
void	ClearComponentMap (void)
void	SetupControlInterface (void)
Protected Member Functions inherited from mtsTaskFromSignal
void	Init (void)
void *	RunInternal (void *argument) override
void	PostCommandQueuedMethod (void)
Protected Member Functions inherited from mtsTaskContinuous
virtual void	StartInternal (void)
Protected Member Functions inherited from mtsTask
virtual const mtsManagerComponentServices *	GetManagerComponentServices (void) const override
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) override
Protected Member Functions inherited from mtsComponent
	mtsComponent (void)
	mtsComponent (const mtsComponent &other)
void	Initialize (void)
mtsInterfaceRequired *	AddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)
mtsInterfaceRequired *	AddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)
mtsInterfaceProvided *	AddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)
mtsInterfaceInput *	AddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)
mtsInterfaceOutput *	AddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)
void	KillSeparateLogFile (void)
size_t	ProcessMailBoxes (InterfacesProvidedMapType &interfaces)
size_t	ProcessQueuedCommands (void)
size_t	ProcessQueuedEvents (void)
mtsInterfaceRequired *	EnableDynamicComponentManagement (void)
	Enable support for dynamic component management services.
bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces.
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)

Protected Attributes
CollectorStatus	Status
CollectorFileFormat	FileFormat
ComponentMapType	ComponentMap
bool	ConnectedFlag
bool	FirstRunningFlag
size_t	SampleCounter
size_t	SampleCounterForEvent
double	TimeIntervalForProgressEvent
double	TimeOfLastProgressEvent
std::string	OutputFileName
std::string	OutputHeaderFileName
std::string	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
cmnSerializer *	Serializer = nullptr
mtsInterfaceProvided *	ControlInterface
Protected Attributes inherited from mtsTaskFromSignal
mtsCallableVoidBase *	PostCommandQueuedCallable
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
mtsCallableVoidBase *	InterfaceProvidedToManagerCallable
mtsInterfaceRequired *	ExecIn
mtsInterfaceProvided *	ExecOut
mtsFunctionVoid	RunEventInternal
bool	RunEventCalled
mtsFunctionWrite	ChangeStateEvent
Protected Attributes inherited from mtsComponent
std::string	Name
mtsComponentState	State
std::set< std::string >	mTags
mtsInterfaceProvided *	InterfaceProvidedToManager
bool	UseSeparateLogFileFlag
cmnLogger::StreamBufType *	LoDMultiplexerStreambuf
std::ofstream *	LogFile
InterfacesProvidedMapType	InterfacesProvided
InterfacesOutputMapType	InterfacesOutput
InterfacesRequiredMapType	InterfacesRequired
InterfacesInputMapType	InterfacesInput
StateTableMapType	StateTables
mtsManagerComponentServices *	ManagerComponentServices
mtsFunctionWrite	EventGeneratorChangeState
bool	ReplayMode

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

◆ ComponentMapType

typedef cmnNamedMap<SignalMapType> mtsCollectorBase::ComponentMapType

protected

◆ SignalMapType

typedef cmnNamedMap<SignalMapElement> mtsCollectorBase::SignalMapType

protected

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

Member Enumeration Documentation

◆ CollectorFileFloatingNotation

enum mtsCollectorBase::CollectorFileFloatingNotation

Enumerator
COLLECTOR_FILE_FLOATING_NOTATION_NONE
COLLECTOR_FILE_FLOATING_NOTATION_FIXED
COLLECTOR_FILE_FLOATING_NOTATION_SCIENTIFIC

◆ CollectorFileFormat

enum mtsCollectorBase::CollectorFileFormat

Enumerator
COLLECTOR_FILE_FORMAT_PLAIN_TEXT
COLLECTOR_FILE_FORMAT_BINARY
COLLECTOR_FILE_FORMAT_CSV
COLLECTOR_FILE_FORMAT_UNDEFINED

◆ CollectorStatus

enum mtsCollectorBase::CollectorStatus

protected

State definition of the collector

Enumerator
COLLECTOR_STOP
COLLECTOR_WAIT_START
COLLECTOR_COLLECTING
COLLECTOR_WAIT_STOP

Constructor & Destructor Documentation

◆ mtsCollectorBase()

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

◆ ~mtsCollectorBase()

virtual mtsCollectorBase::~mtsCollectorBase ( void )

virtual

Member Function Documentation

◆ Cleanup()

void mtsCollectorBase::Cleanup ( void )

protectedvirtual

Clean up internal data.

Reimplemented from mtsComponent.

Reimplemented in mtsCollectorFactory.

◆ ClearComponentMap()

void mtsCollectorBase::ClearComponentMap ( void )

protected

Clear ComponentMap

◆ CloseOutput()

void mtsCollectorBase::CloseOutput ( void )

Closes the output file stream

◆ Connect()

virtual bool mtsCollectorBase::Connect ( void )

pure virtual

Connect to all the components and interfaces used to collect data.

Implemented in mtsCollectorEvent, mtsCollectorFactory, and mtsCollectorState.

◆ GetDefaultOutputName()

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

inlinevirtual

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

Reimplemented in mtsCollectorEvent.

◆ GetOutputFileName()

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

inline

Get the name of log file currently being written.

◆ GetWorkingDirectory()

void mtsCollectorBase::GetWorkingDirectory ( std::string & placeHolder ) const

Get working directory, usable with commands as well

◆ Init()

void mtsCollectorBase::Init ( void )

protected

Initialize this collector instance

◆ OpenFileIfNeeded()

void mtsCollectorBase::OpenFileIfNeeded ( void )

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

◆ SetDelimiter()

void mtsCollectorBase::SetDelimiter ( void )

protected

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

◆ SetOutput() [1/3]

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.

◆ SetOutput() [2/3]

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.

◆ SetOutput() [3/3]

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.

◆ SetOutputStreamFill()

void mtsCollectorBase::SetOutputStreamFill ( const char fillCharacter )

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

◆ SetOutputStreamFloatingNotation()

void mtsCollectorBase::SetOutputStreamFloatingNotation ( const CollectorFileFloatingNotation floatingNotation )

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

◆ SetOutputStreamParams()

void mtsCollectorBase::SetOutputStreamParams ( void )

protected

Setup the parameters for the collector output stream.

◆ SetOutputStreamPrecision()

void mtsCollectorBase::SetOutputStreamPrecision ( const int precision )

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

◆ SetOutputStreamWidth()

void mtsCollectorBase::SetOutputStreamWidth ( const int width )

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

◆ SetOutputToDefault() [1/2]

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

◆ SetOutputToDefault() [2/2]

virtual void mtsCollectorBase::SetOutputToDefault ( void )

virtual

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.

Reimplemented in mtsCollectorFactory.

◆ SetOutputToDefaultCommand()

void mtsCollectorBase::SetOutputToDefaultCommand ( void )

inlineprotected

◆ SetupControlInterface()

void mtsCollectorBase::SetupControlInterface ( void )

protected

Create the provided interface for control.

◆ SetWorkingDirectory()

virtual void mtsCollectorBase::SetWorkingDirectory ( const std::string & directory )

virtual

Set working directory, usable with commands as well

Reimplemented in mtsCollectorFactory.

◆ SetWorkingDirectoryCommand()

void mtsCollectorBase::SetWorkingDirectoryCommand ( const std::string & directory )

inlineprotected

◆ StartCollection()

virtual void mtsCollectorBase::StartCollection ( const double & 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, mtsCollectorFactory, and mtsCollectorState.

◆ StartCollectionCommand()

void mtsCollectorBase::StartCollectionCommand ( const double & delayInSeconds )

inlineprotected

Methods used to populate the component provided interface.

◆ StopCollection()

virtual void mtsCollectorBase::StopCollection ( const double & 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, mtsCollectorFactory, and mtsCollectorState.

◆ StopCollectionCommand()

void mtsCollectorBase::StopCollectionCommand ( const double & delayInSeconds )

inlineprotected

◆ mtsCollectorBaseTest

friend class mtsCollectorBaseTest

friend

Member Data Documentation

◆ CollectionStartedEventTrigger

mtsFunctionWrite mtsCollectorBase::CollectionStartedEventTrigger

Function used to trigger Collection Started event.

◆ ComponentMap

ComponentMapType mtsCollectorBase::ComponentMap

protected

◆ ConnectedFlag

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

◆ ControlInterface

mtsInterfaceProvided* mtsCollectorBase::ControlInterface

protected

Default control interface and methods used for the provided commands.

◆ Delimiter

char mtsCollectorBase::Delimiter

protected

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

◆ FileFormat

CollectorFileFormat mtsCollectorBase::FileFormat

protected

◆ FileOpened

bool mtsCollectorBase::FileOpened

protected

Check if the output file is already opened

◆ FillCharacter

char mtsCollectorBase::FillCharacter

protected

Collector File fill value [DEFAULT = ' ']

◆ FirstRunningFlag

bool mtsCollectorBase::FirstRunningFlag

protected

Flag for PrintHeader() method.

◆ FloatingNotation

CollectorFileFloatingNotation mtsCollectorBase::FloatingNotation

protected

Collector File floating notation enum, default is COLLECTOR_FILE_FLOATING_NOTATION_NONE

◆ OutputFile

std::ofstream* mtsCollectorBase::OutputFile

protected

◆ OutputFileName

std::string mtsCollectorBase::OutputFileName

protected

Output file name, including working directory.

◆ OutputHeaderFile

std::ofstream* mtsCollectorBase::OutputHeaderFile

protected

◆ OutputHeaderFileName

std::string mtsCollectorBase::OutputHeaderFileName

protected

◆ OutputHeaderStream

std::ostream* mtsCollectorBase::OutputHeaderStream

protected

◆ OutputStream

std::ostream* mtsCollectorBase::OutputStream

protected

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

◆ Precision

std::streamsize mtsCollectorBase::Precision

protected

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

◆ ProgressEventTrigger

mtsFunctionWrite mtsCollectorBase::ProgressEventTrigger

Function used to trigger Progress event.

◆ SampleCounter

size_t mtsCollectorBase::SampleCounter

protected

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

◆ SampleCounterForEvent

size_t mtsCollectorBase::SampleCounterForEvent

protected

Counter for number of sample since the last CollectionStopped event

◆ Serializer

cmnSerializer* mtsCollectorBase::Serializer = nullptr

protected

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

◆ Status

CollectorStatus mtsCollectorBase::Status

protected

◆ StringStreamBufferForSerialization

std::stringstream mtsCollectorBase::StringStreamBufferForSerialization

protected

String stream buffer for serialization.

◆ TimeIntervalForProgressEvent

double mtsCollectorBase::TimeIntervalForProgressEvent

protected

Interval between two progress events (in seconds)

◆ TimeOfLastProgressEvent

double mtsCollectorBase::TimeOfLastProgressEvent

protected

Time of last progress event

◆ Width

std::streamsize mtsCollectorBase::Width

protected

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

◆ WorkingDirectoryMember

std::string mtsCollectorBase::WorkingDirectoryMember

protected

Current directory to save data

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

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

Classes

Public Types

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ComponentMapType

◆ SignalMapType

Member Enumeration Documentation

◆ CollectorFileFloatingNotation

◆ CollectorFileFormat

◆ CollectorStatus

Constructor & Destructor Documentation

◆ mtsCollectorBase()

◆ ~mtsCollectorBase()

Member Function Documentation

◆ Cleanup()

◆ ClearComponentMap()

◆ CloseOutput()

◆ Connect()

◆ GetDefaultOutputName()

◆ GetOutputFileName()

◆ GetWorkingDirectory()

◆ Init()

◆ OpenFileIfNeeded()

◆ SetDelimiter()

◆ SetOutput() [1/3]

◆ SetOutput() [2/3]

◆ SetOutput() [3/3]

◆ SetOutputStreamFill()

◆ SetOutputStreamFloatingNotation()

◆ SetOutputStreamParams()

◆ SetOutputStreamPrecision()

◆ SetOutputStreamWidth()

◆ SetOutputToDefault() [1/2]

◆ SetOutputToDefault() [2/2]

◆ SetOutputToDefaultCommand()

◆ SetupControlInterface()

◆ SetWorkingDirectory()

◆ SetWorkingDirectoryCommand()

◆ StartCollection()

◆ StartCollectionCommand()

◆ StopCollection()

◆ StopCollectionCommand()

Friends And Related Symbol Documentation

◆ mtsCollectorBaseTest

Member Data Documentation

◆ CollectionStartedEventTrigger

◆ ComponentMap

◆ ConnectedFlag

◆ ControlInterface

◆ Delimiter

◆ FileFormat

◆ FileOpened

◆ FillCharacter

◆ FirstRunningFlag

◆ FloatingNotation

◆ OutputFile

◆ OutputFileName

◆ OutputHeaderFile

◆ OutputHeaderFileName

◆ OutputHeaderStream

◆ OutputStream

◆ Precision

◆ ProgressEventTrigger

◆ SampleCounter

◆ SampleCounterForEvent

◆ Serializer

◆ Status

◆ StringStreamBufferForSerialization

◆ TimeIntervalForProgressEvent

◆ TimeOfLastProgressEvent

◆ Width

◆ WorkingDirectoryMember