mtsCollectorEvent Class Reference
[Multi Task Support]

#include <mtsCollectorEvent.h>

Inheritance diagram for mtsCollectorEvent:

[legend]Collaboration diagram for mtsCollectorEvent:

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.

Definition at line 45 of file mtsCollectorEvent.h.

typedef cmnNamedMap< mtsInterfaceRequired > InterfacesRequiredMap
typedef cmnNamedMap< InterfacesRequiredMap > ComponentsMap
ComponentsMap ObservedComponents

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)
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)

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 Attributes

std::vector< CollectorEventVoid * > EventsVoid
std::vector< CollectorEventWrite * > EventsWrite

Classes

class CollectorEventVoid
class CollectorEventWrite

Member Typedef Documentation

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.

Definition at line 63 of file mtsCollectorEvent.h.

typedef cmnNamedMap<InterfacesRequiredMap> mtsCollectorEvent::ComponentsMap [protected]

Definition at line 64 of file mtsCollectorEvent.h.

Constructor & Destructor Documentation

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

Constructor, requires to name the collector task.

Member Function Documentation

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]`

Utility methods to check availibility of components, interfaces and events

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::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

bool mtsCollectorEvent::CheckCollectingStatus ( void ) [protected]

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

void mtsCollectorEvent::Run ( void ) [virtual]

Thread-related methods

Implements mtsTask.

void mtsCollectorEvent::Startup ( void ) [virtual]

Set some initial values

Implements mtsCollectorBase.

void mtsCollectorEvent::Initialize ( void )

Initialization

Reimplemented from mtsComponent.

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

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

Implements mtsCollectorBase.

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::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::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::AddObservedEventWrite	(	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 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.

void mtsCollectorEvent::PrintHeader ( const CollectorFileFormat & fileFormat ) [protected]

Print out the event names which are being collected.

bool mtsCollectorEvent::Connect ( void )

Todo:: copy documentation for mtsCollectorState

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::StopCollection ( 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.