#include <mtsCollectorEvent.h>

Inheritance diagram for mtsCollectorEvent:

Classes
class	CollectorEventVoid

class	CollectorEventWrite

Public Member Functions
void	Run (void)

void	Startup (void)

void	Initialize (void)

virtual std::string	GetDefaultOutputName (void)

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

	~mtsCollectorEvent (void)

bool	AddObservedComponent (const std::string &componentName)

bool	AddObservedComponent (const mtsComponent *componentPointer)

bool	AddObservedInterface (const std::string &componentName, const std::string &interfaceName)

bool	Connect (void)


bool	AddObservedEventVoid (const std::string &componentName, const std::string &interfaceName, const std::string &eventName)

bool	AddObservedEventWrite (const std::string &componentName, const std::string &interfaceName, const std::string &eventName)


void	StartCollection (const mtsDouble &delayInSeconds)

void	StopCollection (const mtsDouble &delayInSeconds)

Public Member Functions inherited from mtsCollectorBase
	mtsCollectorBase (const std::string &collectorName, const CollectorFileFormat fileFormat)

virtual	~mtsCollectorBase (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	SetOutputToDefault (void)

void	CloseOutput (void)

const std::string &	GetOutputFileName (void) const

void	OpenFileIfNeeded (void)

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)

mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED)

mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (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	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

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	SetName (const std::string &componentName)

virtual void	Configure (const std::string &filename="")

bool	CreateAndWait (double timeoutInSeconds)

bool	StartAndWait (double timeoutInSeconds)

bool	KillAndWait (double timeoutInSeconds)

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)

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, const bool skipDisconnect=false)

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)

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, const bool skipDisconnect=false)

const mtsManagerComponentServices *	GetManagerComponentServices (void) const

mtsManagerComponentServices *	GetManagerComponentServices (void)

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

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

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

Protected Member Functions
mtsInterfaceRequired *	GetInterfaceRequiredFor (const mtsComponent componentPointer, const mtsInterfaceProvided interfacePointer)

void	SaveEventVoid (const CollectorEventVoid *event)

void	SaveEventWrite (const CollectorEventWrite *event, const mtsGenericObject &payload)

bool	CheckCollectingStatus (void)

bool	AddObservedInterface (const mtsComponent componentPointer, const mtsInterfaceProvided interfacePointer)

void	PrintHeader (const CollectorFileFormat &fileFormat)

void	SetCollecting (bool collecting, double currentTime)


mtsComponent *	CheckComponent (const std::string &componentName) const

mtsInterfaceProvided *	CheckInterface (const mtsComponent *componentPointer, const std::string &interfaceName) const


bool	AddObservedEventVoid (const mtsComponent componentPointer, const mtsInterfaceProvided interfacePointer, const std::string &eventName)

bool	AddObservedEventWrite (const mtsComponent componentPointer, const mtsInterfaceProvided interfacePointer, const std::string &eventName)

Protected Member Functions inherited from mtsCollectorBase
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)

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)

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. 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
size_t	EventCounter

bool	Collecting

double	ScheduledStartTime

double	ScheduledStopTime

const osaTimeServer *	TimeServer


std::vector< CollectorEventVoid * >	EventsVoid

std::vector < CollectorEventWrite * >	EventsWrite

Protected Attributes inherited from mtsCollectorBase
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

cmnSerializer *	Serializer

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

mtsInterfaceProvided *	InterfaceProvidedToManager

bool	UseSeparateLogFileFlag

cmnLogger::StreamBufType *	LoDMultiplexerStreambuf

std::ofstream *	LogFile

StateTableMapType	StateTables

mtsManagerComponentServices *	ManagerComponentServices

mtsFunctionWrite	EventGeneratorChangeState

bool	ReplayMode

InterfacesProvidedMapType	InterfacesProvided

InterfacesOutputMapType	InterfacesOutput

InterfacesRequiredMapType	InterfacesRequired

InterfacesInputMapType	InterfacesInput

typedef cmnNamedMap < mtsInterfaceRequired >	InterfacesRequiredMap

typedef cmnNamedMap < InterfacesRequiredMap >	ComponentsMap

ComponentsMap	ObservedComponents

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
mtsFunctionVoid	CollectionStartedEventTrigger

mtsFunctionWrite	CollectionStoppedEventTrigger

mtsFunctionWrite	ProgressEventTrigger

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

Protected Types inherited from mtsCollectorBase
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

Static Protected Attributes inherited from mtsCollectorBase
static mtsComponentManager *	ComponentManager

Detailed Description

This class provides a way to collect event from multiple components and interfaces. It uses a separate thread and subscribes to all specified events. When an event is received, the thread is waken-up and the event is recorded.

Member Typedef Documentation

typedef cmnNamedMap<InterfacesRequiredMap> mtsCollectorEvent::ComponentsMap

protected

typedef cmnNamedMap<mtsInterfaceRequired> mtsCollectorEvent::InterfacesRequiredMap

protected

We need to keep a list of components the event collector will connect from. Each component can then have one or more provided interface and for each provided interface we will need to create a required interface. For this, we use a map of maps.

Constructor & Destructor Documentation

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

Constructor, requires to name the collector task.

mtsCollectorEvent::~mtsCollectorEvent ( void )

Member Function Documentation

bool mtsCollectorEvent::AddObservedComponent ( const std::string & componentName )

Tells the collector to collect all events coming from a given component (all interfaces and all events).

bool mtsCollectorEvent::AddObservedComponent ( const mtsComponent * componentPointer )

Tells the collector to collect all events coming from a given component (all interfaces and all events). This method assumes the pointer is valid.

bool mtsCollectorEvent::AddObservedEventVoid	(	const std::string &	componentName,
		const std::string &	interfaceName,
		const std::string &	eventName
	)

Tells the collector to collect all events coming from a given event.

bool mtsCollectorEvent::AddObservedEventVoid	(	const mtsComponent *	componentPointer,
		const mtsInterfaceProvided *	interfacePointer,
		const std::string &	eventName
	)

protected

Tells the collector to collect all events coming from a given event. These methods assumes that all pointers are valid.

bool mtsCollectorEvent::AddObservedEventWrite	(	const std::string &	componentName,
		const std::string &	interfaceName,
		const std::string &	eventName
	)

bool mtsCollectorEvent::AddObservedEventWrite	(	const mtsComponent *	componentPointer,
		const mtsInterfaceProvided *	interfacePointer,
		const std::string &	eventName
	)

protected

bool mtsCollectorEvent::AddObservedInterface	(	const std::string &	componentName,
		const std::string &	interfaceName
	)

Tells the collector to collect all events coming from a given interface (all events).

bool mtsCollectorEvent::AddObservedInterface	(	const mtsComponent *	componentPointer,
		const mtsInterfaceProvided *	interfacePointer
	)

protected

Tells the collector to collect all events coming from a given interface (all events). This methods assumes that both pointers are valid.

bool mtsCollectorEvent::CheckCollectingStatus ( void )

protected

Update and return the collecting status based on the scheduled start/stop time and current time.

mtsComponent* mtsCollectorEvent::CheckComponent ( const std::string & componentName ) const

protected

Utility methods to check availibility of components, interfaces and events

mtsInterfaceProvided* mtsCollectorEvent::CheckInterface	(	const mtsComponent *	componentPointer,
		const std::string &	interfaceName
	)		const

protected

bool mtsCollectorEvent::Connect ( void )

Todo:: copy documentation for mtsCollectorState

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

virtual

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

Implements mtsCollectorBase.

mtsInterfaceRequired* mtsCollectorEvent::GetInterfaceRequiredFor	(	const mtsComponent *	componentPointer,
		const mtsInterfaceProvided *	interfacePointer
	)

protected

Get the required interface associated to a specific connection defined by the component and interface. If the required interface doesn't exist yet, a new one is being created.

void mtsCollectorEvent::Initialize ( void )

Initialization

void mtsCollectorEvent::PrintHeader ( const CollectorFileFormat & fileFormat )

protected

Print out the event names which are being collected.

void mtsCollectorEvent::Run ( void )

virtual

Thread-related methods

Implements mtsTask.

void mtsCollectorEvent::SaveEventVoid ( const CollectorEventVoid * event )

protected

Save the event information

void mtsCollectorEvent::SaveEventWrite	(	const CollectorEventWrite *	event,
		const mtsGenericObject &	payload
	)

protected

Save the event information and payload

void mtsCollectorEvent::SetCollecting	(	bool	collecting,
		double	currentTime
	)

protected

void mtsCollectorEvent::StartCollection ( const mtsDouble & delayInSeconds )

virtual

Methods defined as virtual in base class to control stop/start collection with delay. For the event collector, these methods will enable/disable all event observers.

Implements mtsCollectorBase.

void mtsCollectorEvent::Startup ( void )

virtual

Set some initial values

Implements mtsCollectorBase.

void mtsCollectorEvent::StopCollection ( const mtsDouble & delayInSeconds )

virtual

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

Implements mtsCollectorBase.

Member Data Documentation

bool mtsCollectorEvent::Collecting

protected

Flag indicating if the collector is started

size_t mtsCollectorEvent::EventCounter

protected

Counter used to give a unique Id to each event, starts at 1

std::vector<CollectorEventVoid *> mtsCollectorEvent::EventsVoid

protected

Lists of event handlers

std::vector<CollectorEventWrite *> mtsCollectorEvent::EventsWrite

protected

ComponentsMap mtsCollectorEvent::ObservedComponents

protected

double mtsCollectorEvent::ScheduledStartTime

protected

Scheduled start. If time is set to zero, there is no scheduled start

double mtsCollectorEvent::ScheduledStopTime

protected

Scheduled start. If time is set to zero, there is no scheduled start

const osaTimeServer* mtsCollectorEvent::TimeServer

protected

Pointer on manager's time server

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

/home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsCollectorEvent.h

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation