#include <mtsManagerComponentServices.h>

Inheritance diagram for mtsManagerComponentServices:

Classes
struct	ManagementStruct
struct	GetterStruct
struct	EventStruct

Public Member Functions
	mtsManagerComponentServices (mtsInterfaceRequired *internalInterfaceRequired)
	~mtsManagerComponentServices ()
bool	InitializeInterfaceInternalRequired (void)
bool	IsConnected (void) const
template<class __classType>
bool	AddComponentEventHandler (void(__classType::method)(const mtsDescriptionComponent &), __classType classInstantiation, mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
template<class __classType>
bool	AddConnectionEventHandler (void(__classType::method)(const mtsDescriptionConnection &), __classType classInstantiation, mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
template<class __classType>
bool	RemoveConnectionEventHandler (void(__classType::method)(const mtsDescriptionConnection &), __classType classInstantiation, mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
template<class __classType>
bool	ChangeStateEventHandler (void(__classType::method)(const mtsComponentStateChange &), __classType classInstantiation, mtsEventQueueingPolicy queueingPolicy=MTS_INTERFACE_EVENT_POLICY)
bool	ComponentCreate (const std::string &className, const std::string &componentName) const
bool	ComponentCreate (const std::string &processName, const std::string &className, const std::string &componentName) const
bool	ComponentCreate (const std::string &className, const mtsGenericObject &constructorArg) const
bool	ComponentCreate (const std::string &processName, const std::string &className, const mtsGenericObject &constructorArg) const
bool	ComponentAdd (const mtsComponent *component) const
bool	ComponentRemove (const mtsComponent *component) const
bool	ComponentRemove (const std::string &componentName) const
mtsComponent *	ComponentGet (const std::string &componentName) const
bool	ComponentConfigure (const std::string &componentName, const std::string &configString) const
bool	ComponentConfigure (const std::string &processName, const std::string &componentName, const std::string &configString) const
bool	Connect (const std::string &clientComponentName, const std::string &clientInterfaceName, const std::string &serverComponentName, const std::string &serverInterfaceName) const
bool	Connect (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceName) const
bool	Connect (const mtsDescriptionConnection &connection) const
bool	Disconnect (const std::string &clientComponentName, const std::string &clientInterfaceName, const std::string &serverComponentName, const std::string &serverInterfaceName) const
bool	Disconnect (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceName) const
bool	Disconnect (const mtsDescriptionConnection &connection) const
bool	Disconnect (ConnectionIDType connectionID) const
bool	ComponentStart (const std::string &componentName, const double delayInSecond) const
bool	ComponentStart (const std::string &componentName) const
bool	ComponentStart (const std::string &processName, const std::string &componentName, const double delayInSecond) const
bool	ComponentStart (const std::string &processName, const std::string &componentName) const
bool	ComponentStop (const std::string &componentName, const double delayInSecond) const
bool	ComponentStop (const std::string &componentName) const
bool	ComponentStop (const std::string &processName, const std::string &componentName, const double delayInSecond) const
bool	ComponentStop (const std::string &processName, const std::string &componentName) const
bool	ComponentResume (const std::string &componentName, const double delayInSecond=0.0) const
bool	ComponentResume (const std::string &processName, const std::string &componentName, const double delayInSecond=0.0) const
mtsComponentState	ComponentGetState (const mtsDescriptionComponent &component) const
std::string	ComponentGetState (const std::string componentName) const
std::string	ComponentGetState (const std::string &processName, const std::string componentName) const
std::vector< std::string >	GetNamesOfProcesses (void) const
std::vector< std::string >	GetNamesOfComponents (const std::string &processName) const
std::vector< std::string >	GetNamesOfComponents (void) const
std::vector< mtsDescriptionComponent >	GetDescriptionsOfComponents (const std::string &processName) const
bool	GetNamesOfInterfaces (const std::string &processName, const std::string &componentName, std::vector< std::string > &namesOfInterfacesRequired, std::vector< std::string > &namesOfInterfacesProvided) const
bool	GetDescriptionsOfInterfaces (const std::string &processName, const std::string &componentName, std::vector< mtsDescriptionInterfaceFullName > &descriptionsRequired, std::vector< mtsDescriptionInterfaceFullName > &descriptionsProvided) const
std::vector< mtsDescriptionConnection >	GetListOfConnections (void) const
std::vector< mtsDescriptionComponentClass >	GetListOfComponentClasses (const std::string &processName="") const
mtsInterfaceProvidedDescription	GetInterfaceProvidedDescription (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
mtsInterfaceProvidedDescription	GetInterfaceProvidedDescription (const std::string &componentName, const std::string &interfaceName) const
mtsInterfaceProvidedDescription	GetInterfaceProvidedDescription (const mtsDescriptionInterfaceFullName &interfaceDescription) const
mtsInterfaceRequiredDescription	GetInterfaceRequiredDescription (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
mtsInterfaceRequiredDescription	GetInterfaceRequiredDescription (const std::string &componentName, const std::string &interfaceName) const
mtsInterfaceRequiredDescription	GetInterfaceRequiredDescription (const mtsDescriptionInterfaceFullName &interfaceDescription) const
bool	Load (const std::string &fileName) const
bool	Load (const std::string &processName, const std::string &fileName) const
bool	WaitFor (const std::string &processName, double timeoutInSec=-1.0)
bool	WaitFor (const std::string &processName, const std::string &componentName, double timeoutInSec=-1.0)
bool	WaitFor (const std::string &processName, const std::string &componentName, const std::string &state, double timeoutInSec=-1.0)
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	ToStream (std::ostream &outputStream) 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 cmnLogger::StreamBufType *	GetLogMultiplexer (void) const
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 Member Functions
bool	CheckAndWait (const std::vector< std::string > &list, const std::string &key, double &timeoutInSec, mtsEventReceiverWrite &eventReceiver)

Protected Attributes
mtsInterfaceRequired *	InternalInterfaceRequired
struct mtsManagerComponentServices::ManagementStruct	ServiceComponentManagement
struct mtsManagerComponentServices::GetterStruct	ServiceGetters
struct mtsManagerComponentServices::EventStruct	EventReceivers

Constructor & Destructor Documentation

◆ mtsManagerComponentServices()

mtsManagerComponentServices::mtsManagerComponentServices ( mtsInterfaceRequired * internalInterfaceRequired )

◆ ~mtsManagerComponentServices()

mtsManagerComponentServices::~mtsManagerComponentServices ( )

inline

Member Function Documentation

◆ AddComponentEventHandler()

template<class __classType>

bool mtsManagerComponentServices::AddComponentEventHandler	(	void(__classType::*	method )(const mtsDescriptionComponent &),
		__classType *	classInstantiation,
		mtsEventQueueingPolicy	queueingPolicy = MTS_INTERFACE_EVENT_POLICY )

inline

Add event handlers to the internal required interface

◆ AddConnectionEventHandler()

template<class __classType>

bool mtsManagerComponentServices::AddConnectionEventHandler	(	void(__classType::*	method )(const mtsDescriptionConnection &),
		__classType *	classInstantiation,
		mtsEventQueueingPolicy	queueingPolicy = MTS_INTERFACE_EVENT_POLICY )

inline

◆ ChangeStateEventHandler()

template<class __classType>

bool mtsManagerComponentServices::ChangeStateEventHandler	(	void(__classType::*	method )(const mtsComponentStateChange &),
		__classType *	classInstantiation,
		mtsEventQueueingPolicy	queueingPolicy = MTS_INTERFACE_EVENT_POLICY )

inline

◆ CheckAndWait()

bool mtsManagerComponentServices::CheckAndWait	(	const std::vector< std::string > &	list,
		const std::string &	key,
		double &	timeoutInSec,
		mtsEventReceiverWrite &	eventReceiver )

protected

◆ ComponentAdd()

bool mtsManagerComponentServices::ComponentAdd ( const mtsComponent * component ) const

◆ ComponentConfigure() [1/2]

bool mtsManagerComponentServices::ComponentConfigure	(	const std::string &	componentName,
		const std::string &	configString ) const

◆ ComponentConfigure() [2/2]

bool mtsManagerComponentServices::ComponentConfigure	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	configString ) const

◆ ComponentCreate() [1/4]

bool mtsManagerComponentServices::ComponentCreate	(	const std::string &	className,
		const mtsGenericObject &	constructorArg ) const

◆ ComponentCreate() [2/4]

bool mtsManagerComponentServices::ComponentCreate	(	const std::string &	className,
		const std::string &	componentName ) const

Wrappers for internal function objects

◆ ComponentCreate() [3/4]

bool mtsManagerComponentServices::ComponentCreate	(	const std::string &	processName,
		const std::string &	className,
		const mtsGenericObject &	constructorArg ) const

◆ ComponentCreate() [4/4]

bool mtsManagerComponentServices::ComponentCreate	(	const std::string &	processName,
		const std::string &	className,
		const std::string &	componentName ) const

◆ ComponentGet()

mtsComponent * mtsManagerComponentServices::ComponentGet ( const std::string & componentName ) const

◆ ComponentGetState() [1/3]

mtsComponentState mtsManagerComponentServices::ComponentGetState ( const mtsDescriptionComponent & component ) const

◆ ComponentGetState() [2/3]

std::string mtsManagerComponentServices::ComponentGetState	(	const std::string &	processName,
		const std::string	componentName ) const

◆ ComponentGetState() [3/3]

std::string mtsManagerComponentServices::ComponentGetState ( const std::string componentName ) const

◆ ComponentRemove() [1/2]

bool mtsManagerComponentServices::ComponentRemove ( const mtsComponent * component ) const

◆ ComponentRemove() [2/2]

bool mtsManagerComponentServices::ComponentRemove ( const std::string & componentName ) const

◆ ComponentResume() [1/2]

bool mtsManagerComponentServices::ComponentResume	(	const std::string &	componentName,
		const double	delayInSecond = 0.0 ) const

◆ ComponentResume() [2/2]

bool mtsManagerComponentServices::ComponentResume	(	const std::string &	processName,
		const std::string &	componentName,
		const double	delayInSecond = 0.0 ) const

◆ ComponentStart() [1/4]

bool mtsManagerComponentServices::ComponentStart ( const std::string & componentName ) const

inline

◆ ComponentStart() [2/4]

bool mtsManagerComponentServices::ComponentStart	(	const std::string &	componentName,
		const double	delayInSecond ) const

◆ ComponentStart() [3/4]

bool mtsManagerComponentServices::ComponentStart	(	const std::string &	processName,
		const std::string &	componentName ) const

inline

◆ ComponentStart() [4/4]

bool mtsManagerComponentServices::ComponentStart	(	const std::string &	processName,
		const std::string &	componentName,
		const double	delayInSecond ) const

◆ ComponentStop() [1/4]

bool mtsManagerComponentServices::ComponentStop ( const std::string & componentName ) const

inline

◆ ComponentStop() [2/4]

bool mtsManagerComponentServices::ComponentStop	(	const std::string &	componentName,
		const double	delayInSecond ) const

◆ ComponentStop() [3/4]

bool mtsManagerComponentServices::ComponentStop	(	const std::string &	processName,
		const std::string &	componentName ) const

inline

◆ ComponentStop() [4/4]

bool mtsManagerComponentServices::ComponentStop	(	const std::string &	processName,
		const std::string &	componentName,
		const double	delayInSecond ) const

◆ Connect() [1/3]

bool mtsManagerComponentServices::Connect ( const mtsDescriptionConnection & connection ) const

◆ Connect() [2/3]

bool mtsManagerComponentServices::Connect	(	const std::string &	clientComponentName,
		const std::string &	clientInterfaceName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceName ) const

◆ Connect() [3/3]

bool mtsManagerComponentServices::Connect	(	const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceName ) const

◆ Disconnect() [1/4]

bool mtsManagerComponentServices::Disconnect ( ConnectionIDType connectionID ) const

◆ Disconnect() [2/4]

bool mtsManagerComponentServices::Disconnect ( const mtsDescriptionConnection & connection ) const

◆ Disconnect() [3/4]

bool mtsManagerComponentServices::Disconnect	(	const std::string &	clientComponentName,
		const std::string &	clientInterfaceName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceName ) const

◆ Disconnect() [4/4]

bool mtsManagerComponentServices::Disconnect	(	const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceName ) const

◆ GetDescriptionsOfComponents()

std::vector< mtsDescriptionComponent > mtsManagerComponentServices::GetDescriptionsOfComponents ( const std::string & processName ) const

◆ GetDescriptionsOfInterfaces()

bool mtsManagerComponentServices::GetDescriptionsOfInterfaces	(	const std::string &	processName,
		const std::string &	componentName,
		std::vector< mtsDescriptionInterfaceFullName > &	descriptionsRequired,
		std::vector< mtsDescriptionInterfaceFullName > &	descriptionsProvided ) const

◆ GetInterfaceProvidedDescription() [1/3]

mtsInterfaceProvidedDescription mtsManagerComponentServices::GetInterfaceProvidedDescription ( const mtsDescriptionInterfaceFullName & interfaceDescription ) const

inline

◆ GetInterfaceProvidedDescription() [2/3]

mtsInterfaceProvidedDescription mtsManagerComponentServices::GetInterfaceProvidedDescription	(	const std::string &	componentName,
		const std::string &	interfaceName ) const

inline

◆ GetInterfaceProvidedDescription() [3/3]

mtsInterfaceProvidedDescription mtsManagerComponentServices::GetInterfaceProvidedDescription	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName ) const

◆ GetInterfaceRequiredDescription() [1/3]

mtsInterfaceRequiredDescription mtsManagerComponentServices::GetInterfaceRequiredDescription ( const mtsDescriptionInterfaceFullName & interfaceDescription ) const

inline

◆ GetInterfaceRequiredDescription() [2/3]

mtsInterfaceRequiredDescription mtsManagerComponentServices::GetInterfaceRequiredDescription	(	const std::string &	componentName,
		const std::string &	interfaceName ) const

inline

◆ GetInterfaceRequiredDescription() [3/3]

mtsInterfaceRequiredDescription mtsManagerComponentServices::GetInterfaceRequiredDescription	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName ) const

◆ GetListOfComponentClasses()

std::vector< mtsDescriptionComponentClass > mtsManagerComponentServices::GetListOfComponentClasses ( const std::string & processName = "" ) const

◆ GetListOfConnections()

std::vector< mtsDescriptionConnection > mtsManagerComponentServices::GetListOfConnections ( void ) const

◆ GetNamesOfComponents() [1/2]

std::vector< std::string > mtsManagerComponentServices::GetNamesOfComponents ( const std::string & processName ) const

◆ GetNamesOfComponents() [2/2]

std::vector< std::string > mtsManagerComponentServices::GetNamesOfComponents ( void ) const

inline

◆ GetNamesOfInterfaces()

bool mtsManagerComponentServices::GetNamesOfInterfaces	(	const std::string &	processName,
		const std::string &	componentName,
		std::vector< std::string > &	namesOfInterfacesRequired,
		std::vector< std::string > &	namesOfInterfacesProvided ) const

◆ GetNamesOfProcesses()

std::vector< std::string > mtsManagerComponentServices::GetNamesOfProcesses ( void ) const

◆ InitializeInterfaceInternalRequired()

bool mtsManagerComponentServices::InitializeInterfaceInternalRequired ( void )

◆ IsConnected()

bool mtsManagerComponentServices::IsConnected ( void ) const

inline

◆ Load() [1/2]

bool mtsManagerComponentServices::Load ( const std::string & fileName ) const

◆ Load() [2/2]

bool mtsManagerComponentServices::Load	(	const std::string &	processName,
		const std::string &	fileName ) const

◆ RemoveConnectionEventHandler()

template<class __classType>

bool mtsManagerComponentServices::RemoveConnectionEventHandler	(	void(__classType::*	method )(const mtsDescriptionConnection &),
		__classType *	classInstantiation,
		mtsEventQueueingPolicy	queueingPolicy = MTS_INTERFACE_EVENT_POLICY )

inline

◆ WaitFor() [1/3]

bool mtsManagerComponentServices::WaitFor	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	state,
		double	timeoutInSec = -1.0 )

◆ WaitFor() [2/3]

bool mtsManagerComponentServices::WaitFor	(	const std::string &	processName,
		const std::string &	componentName,
		double	timeoutInSec = -1.0 )

◆ WaitFor() [3/3]

bool mtsManagerComponentServices::WaitFor	(	const std::string &	processName,
		double	timeoutInSec = -1.0 )

Member Data Documentation

◆ EventReceivers

struct mtsManagerComponentServices::EventStruct mtsManagerComponentServices::EventReceivers

protected

◆ InternalInterfaceRequired

mtsInterfaceRequired* mtsManagerComponentServices::InternalInterfaceRequired

protected

◆ ServiceComponentManagement

struct mtsManagerComponentServices::ManagementStruct mtsManagerComponentServices::ServiceComponentManagement

protected

◆ ServiceGetters

struct mtsManagerComponentServices::GetterStruct mtsManagerComponentServices::ServiceGetters

protected

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

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

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ mtsManagerComponentServices()

◆ ~mtsManagerComponentServices()

Member Function Documentation

◆ AddComponentEventHandler()

◆ AddConnectionEventHandler()

◆ ChangeStateEventHandler()

◆ CheckAndWait()

◆ ComponentAdd()

◆ ComponentConfigure() [1/2]

◆ ComponentConfigure() [2/2]

◆ ComponentCreate() [1/4]

◆ ComponentCreate() [2/4]

◆ ComponentCreate() [3/4]

◆ ComponentCreate() [4/4]

◆ ComponentGet()

◆ ComponentGetState() [1/3]

◆ ComponentGetState() [2/3]

◆ ComponentGetState() [3/3]

◆ ComponentRemove() [1/2]

◆ ComponentRemove() [2/2]

◆ ComponentResume() [1/2]

◆ ComponentResume() [2/2]

◆ ComponentStart() [1/4]

◆ ComponentStart() [2/4]

◆ ComponentStart() [3/4]

◆ ComponentStart() [4/4]

◆ ComponentStop() [1/4]

◆ ComponentStop() [2/4]

◆ ComponentStop() [3/4]

◆ ComponentStop() [4/4]

◆ Connect() [1/3]

◆ Connect() [2/3]

◆ Connect() [3/3]

◆ Disconnect() [1/4]

◆ Disconnect() [2/4]

◆ Disconnect() [3/4]

◆ Disconnect() [4/4]

◆ GetDescriptionsOfComponents()

◆ GetDescriptionsOfInterfaces()

◆ GetInterfaceProvidedDescription() [1/3]

◆ GetInterfaceProvidedDescription() [2/3]

◆ GetInterfaceProvidedDescription() [3/3]

◆ GetInterfaceRequiredDescription() [1/3]

◆ GetInterfaceRequiredDescription() [2/3]

◆ GetInterfaceRequiredDescription() [3/3]

◆ GetListOfComponentClasses()

◆ GetListOfConnections()

◆ GetNamesOfComponents() [1/2]

◆ GetNamesOfComponents() [2/2]

◆ GetNamesOfInterfaces()

◆ GetNamesOfProcesses()

◆ InitializeInterfaceInternalRequired()

◆ IsConnected()

◆ Load() [1/2]

◆ Load() [2/2]

◆ RemoveConnectionEventHandler()

◆ WaitFor() [1/3]

◆ WaitFor() [2/3]

◆ WaitFor() [3/3]

Member Data Documentation

◆ EventReceivers

◆ InternalInterfaceRequired

◆ ServiceComponentManagement

◆ ServiceGetters