mtsManagerComponentServices Class Reference

#include <mtsManagerComponentServices.h>

Inheritance diagram for mtsManagerComponentServices:

Classes
struct	EventStruct
struct	GetterStruct
struct	LogStruct
struct	ManagementStruct

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	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
bool	GetNamesOfInterfaces (const std::string &processName, const std::string &componentName, std::vector< std::string > &namesOfInterfacesRequired, std::vector< std::string > &namesOfInterfacesProvided) const
std::vector < mtsDescriptionConnection >	GetListOfConnections (void) const
std::vector < mtsDescriptionComponentClass >	GetListOfComponentClasses (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
mtsInterfaceRequiredDescription	GetInterfaceRequiredDescription (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const
bool	Load (const std::string &fileName) const
bool	Load (const std::string &processName, const std::string &fileName) const
void	EnableLogForwarding (void)
void	EnableLogForwarding (const std::vector< std::string > &processNames)
void	DisableLogForwarding (void)
void	DisableLogForwarding (const std::vector< std::string > &processNames)
void	GetLogForwardingStates (stdCharVec &states) const
void	GetLogForwardingStates (const stdStringVec &processNames, stdCharVec &states) const
std::vector< double >	GetAbsoluteTimeDiffs (const std::vector< std::string > &processNames) 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 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
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::LogStruct	ServiceLogManagement
struct mtsManagerComponentServices::GetterStruct	ServiceGetters
struct mtsManagerComponentServices::EventStruct	EventReceivers

Constructor & Destructor Documentation

mtsManagerComponentServices::mtsManagerComponentServices

(

mtsInterfaceRequired *

internalInterfaceRequired

)

mtsManagerComponentServices::~mtsManagerComponentServices ( )

inline

Member Function Documentation

template<class __classType >

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

inline

Add event handlers to the internal required interface

template<class __classType >

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

inline

template<class __classType >

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

inline

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

protected

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

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

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

Wrappers for internal function objects

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

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

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

mtsComponentState mtsManagerComponentServices::ComponentGetState

(

const mtsDescriptionComponent &

component

)

const

std::string mtsManagerComponentServices::ComponentGetState

(

const std::string

componentName

)

const

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

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

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

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

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

inline

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

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

inline

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

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

inline

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

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

inline

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

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

bool mtsManagerComponentServices::Connect

(

const mtsDescriptionConnection &

connection

)

const

void mtsManagerComponentServices::DisableLogForwarding

(

void

)

void mtsManagerComponentServices::DisableLogForwarding

(

const std::vector< std::string > &

processNames

)

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

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

bool mtsManagerComponentServices::Disconnect

(

const mtsDescriptionConnection &

connection

)

const

bool mtsManagerComponentServices::Disconnect

(

ConnectionIDType

connectionID

)

const

void mtsManagerComponentServices::EnableLogForwarding

(

void

)

void mtsManagerComponentServices::EnableLogForwarding

(

const std::vector< std::string > &

processNames

)

std::vector<double> mtsManagerComponentServices::GetAbsoluteTimeDiffs

(

const std::vector< std::string > &

processNames

)

const

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

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

std::vector<mtsDescriptionComponentClass> mtsManagerComponentServices::GetListOfComponentClasses

(

void

)

const

std::vector<mtsDescriptionComponentClass> mtsManagerComponentServices::GetListOfComponentClasses

(

const std::string &

processName

)

const

std::vector<mtsDescriptionConnection> mtsManagerComponentServices::GetListOfConnections

(

void

)

const

void mtsManagerComponentServices::GetLogForwardingStates

(

stdCharVec &

states

)

const

void mtsManagerComponentServices::GetLogForwardingStates	(	const stdStringVec &	processNames,
		stdCharVec &	states
	)		const

std::vector<std::string> mtsManagerComponentServices::GetNamesOfComponents

(

const std::string &

processName

)

const

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

std::vector<std::string> mtsManagerComponentServices::GetNamesOfProcesses

(

void

)

const

bool mtsManagerComponentServices::InitializeInterfaceInternalRequired

(

void

)

bool mtsManagerComponentServices::IsConnected ( void  ) const

inline

bool mtsManagerComponentServices::Load

(

const std::string &

fileName

)

const

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

template<class __classType >

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

inline

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

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

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

Member Data Documentation

struct mtsManagerComponentServices::EventStruct mtsManagerComponentServices::EventReceivers

protected

mtsInterfaceRequired* mtsManagerComponentServices::InternalInterfaceRequired

protected

struct mtsManagerComponentServices::ManagementStruct mtsManagerComponentServices::ServiceComponentManagement

protected

struct mtsManagerComponentServices::GetterStruct mtsManagerComponentServices::ServiceGetters

protected

struct mtsManagerComponentServices::LogStruct mtsManagerComponentServices::ServiceLogManagement

protected

---

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

• /home/adeguet1/catkin_ws/src/cisst-saw/cisst/cisstMultiTask/mtsManagerComponentServices.h