mtsCollectorFactory Class Reference

#include <mtsCollectorFactory.h>

Inheritance diagram for mtsCollectorFactory:

Public Member Functions
	mtsCollectorFactory (const std::string &componentName)
	~mtsCollectorFactory ()
void	Configure (const std::string &configuration) override
void	Run (void) override
void	Cleanup (void) override
void	AddSignal (const std::string &component, const std::string &table, const std::string &signal)
void	SetSampling (const std::string &component, const std::string &table, const int sampling)
void	AddEventWrite (const std::string &component_name, const std::string &interface_name, const std::string &event_name)
void	AddEventVoid (const std::string &component_name, const std::string &interface_name, const std::string &event_name)
void	AddAllEvents (const std::string &component_name, const std::string &interface_name)
void	AddAllEvents (const std::string &component_name)
bool	Connect (void) override
void	GetCollectorsNames (std::list< std::string > &collectors) const
Public Member Functions inherited from mtsCollectorBase
	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)
void	CloseOutput (void)
const std::string &	GetOutputFileName (void) const
void	OpenFileIfNeeded (void)
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)
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	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)
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

Protected Types
typedef std::pair< std::string, std::string >	CollectorId
Protected Types inherited from mtsCollectorBase
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	AddStateCollector (const std::string &component, const std::string &table)
mtsCollectorEvent *	GetEventCollector (const std::string &component)
void	StartCollection (const double &delayInSeconds) override
void	StopCollection (const double &delayInSeconds) override
void	SetWorkingDirectory (const std::string &directory) override
void	SetOutputToDefault (void) override
void	CollectionStartedEventHandler (const bool &started)
void	ProgressEventHandler (const size_t &counter)
Protected Member Functions inherited from mtsCollectorBase
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	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
std::map< CollectorId, mtsCollectorStateData * >	mStateCollectors
std::map< std::string, mtsCollectorEventData * >	mEventCollectors
std::list< mtsCollectorBaseData * >	mAllCollectors
Protected Attributes inherited from mtsCollectorBase
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	mtsCollectorBaseData

Additional Inherited Members
Public Types inherited from mtsCollectorBase
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 Attributes inherited from mtsCollectorBase
mtsFunctionWrite	CollectionStartedEventTrigger
mtsFunctionWrite	ProgressEventTrigger
Static Public Attributes inherited from mtsTask
static std::runtime_error	UnknownException

Detailed Description

Create collectors using the command pattern or configuration files.

Member Typedef Documentation

CollectorId

typedef std::pair<std::string, std::string> mtsCollectorFactory::CollectorId

protected

Constructor & Destructor Documentation

mtsCollectorFactory()

mtsCollectorFactory::mtsCollectorFactory

(

const std::string &

componentName

)

~mtsCollectorFactory()

mtsCollectorFactory::~mtsCollectorFactory ( )

inline

Member Function Documentation

AddAllEvents() [1/2]

void mtsCollectorFactory::AddAllEvents

(

const std::string &

component_name

)

Add all events for a given component. All provided interfaces will be added. The factory will create an event collector per component observed.

AddAllEvents() [2/2]

void mtsCollectorFactory::AddAllEvents	(	const std::string &	component_name,
		const std::string &	interface_name )

Add all events for a given interface on a component. The factory will create an event collector per component observed.

AddEventVoid()

void mtsCollectorFactory::AddEventVoid	(	const std::string &	component_name,
		const std::string &	interface_name,
		const std::string &	event_name )

AddEventWrite()

void mtsCollectorFactory::AddEventWrite	(	const std::string &	component_name,
		const std::string &	interface_name,
		const std::string &	event_name )

Add a specific event for a given component and interface. The factory will create an event collector per component observed.

AddSignal()

void mtsCollectorFactory::AddSignal	(	const std::string &	component,
		const std::string &	table,
		const std::string &	signal )

Add a signal to collect. If needed, a new state collector will be created for each pair of component/state table. One can call this method multiple times with the same component and/or same component/state table. Attempts to register the same component/table/signal multiple times will be logged as errors using cmnLogger. If an incorrect component, table or signal name is provided, an error message is sent to cmnLogger (check the file cisstLog.txt).

AddStateCollector()

void mtsCollectorFactory::AddStateCollector ( const std::string & component, const std::string & table )

protected

Cleanup()

void mtsCollectorFactory::Cleanup ( void )

overridevirtual

Clean up internal data.

Reimplemented from mtsCollectorBase.

CollectionStartedEventHandler()

void mtsCollectorFactory::CollectionStartedEventHandler ( const bool & started )

protected

Configure()

void mtsCollectorFactory::Configure ( const std::string & filename )

overridevirtual

The virtual method so that the interface or tasks can configure themselves

Reimplemented from mtsComponent.

Connect()

bool mtsCollectorFactory::Connect ( void )

overridevirtual

Connect all the state collectors created using the AddStateCollector. This method must be called after all calls to mtsCollectorFactory::AddSignal and AddEvent.

Implements mtsCollectorBase.

GetCollectorsNames()

void mtsCollectorFactory::GetCollectorsNames

(

std::list< std::string > &

collectors

)

const

Get a list of all collectors names created so far.

GetEventCollector()

mtsCollectorEvent * mtsCollectorFactory::GetEventCollector ( const std::string & component )

protected

ProgressEventHandler()

void mtsCollectorFactory::ProgressEventHandler ( const size_t & counter )

protected

Run()

void mtsCollectorFactory::Run ( void )

overridevirtual

Pure virtual method that gets overloaded to run the actual task.

Implements mtsTask.

SetOutputToDefault()

void mtsCollectorFactory::SetOutputToDefault ( void )

overrideprotectedvirtual

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 from mtsCollectorBase.

SetSampling()

void mtsCollectorFactory::SetSampling	(	const std::string &	component,
		const std::string &	table,
		const int	sampling )

Set sub sampling for data collection. Collect 1 in n.

SetWorkingDirectory()

void mtsCollectorFactory::SetWorkingDirectory ( const std::string & directory )

overrideprotectedvirtual

Set working directory, usable with commands as well

Reimplemented from mtsCollectorBase.

StartCollection()

void mtsCollectorFactory::StartCollection ( const double & delayInSeconds )

overrideprotectedvirtual

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

Implements mtsCollectorBase.

StopCollection()

void mtsCollectorFactory::StopCollection ( const double & delayInSeconds )

overrideprotectedvirtual

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

Implements mtsCollectorBase.

Friends And Related Symbol Documentation

mtsCollectorBaseData

friend class mtsCollectorBaseData

friend

Member Data Documentation

mAllCollectors

std::list<mtsCollectorBaseData *> mtsCollectorFactory::mAllCollectors

protected

mEventCollectors

std::map<std::string, mtsCollectorEventData *> mtsCollectorFactory::mEventCollectors

protected

mStateCollectors

std::map<CollectorId, mtsCollectorStateData *> mtsCollectorFactory::mStateCollectors

protected

---

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

• tmp/cisst-saw/cisst/cisstMultiTask/mtsCollectorFactory.h