#include <mtsManagerGlobalInterface.h>

Inheritance diagram for mtsManagerGlobalInterface:

Public Member Functions
virtual bool	AddProcess (const std::string &processName)=0
	Register process. More...

virtual bool	FindProcess (const std::string &processName) const =0
	Find process. More...

virtual bool	RemoveProcess (const std::string &processName, const bool networkDisconnect)=0
	Remove process. More...

virtual bool	AddComponent (const std::string &processName, const std::string &componentName)=0
	Register component. More...

virtual bool	FindComponent (const std::string &processName, const std::string &componentName) const =0
	Find component using process name and component name. More...

virtual bool	RemoveComponent (const std::string &processName, const std::string &componentName, const bool lock=true)=0
	Remove component. More...

virtual bool	AddInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName)=0
	Register provided interface. Can be called at run-time. More...

virtual bool	AddInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName)=0
	Register required interface. Can be called at run-time. More...

virtual bool	FindInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const =0
	Find provided interface using process name, component name, and interface name. More...

virtual bool	FindInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName) const =0
	Find required interface using process name, component name, and interface name. More...

virtual bool	RemoveInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName, const bool lock=true)=0
	Remove provided interface. Can be called at run-time. More...

virtual bool	RemoveInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName, const bool lock=true)=0
	Remove required interface. Can be called at run-time. More...

virtual ConnectionIDType	Connect (const std::string &requestProcessName, const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)=0
	Connect two interfaces. More...

virtual bool	ConnectConfirm (const ConnectionIDType connectionID)=0
	Confirm that connection has been successfully established. More...

virtual bool	Disconnect (const ConnectionIDType connectionID)=0
	Disconnect two interfaces. More...

virtual bool	Disconnect (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)=0
	Disconnect two interfaces. More...

virtual bool	InitiateConnect (const ConnectionIDType connectionID)=0
	Initiate connection process. More...

virtual bool	ConnectServerSideInterfaceRequest (const ConnectionIDType connectionID)=0
	Request the global component manager to connect interfaces at server side. More...

virtual void	GetListOfConnections (std::vector< mtsDescriptionConnection > &list) const =0

virtual bool	SetInterfaceProvidedProxyAccessInfo (const ConnectionIDType connectionID, const std::string &endpointInfo)=0
	Set access information of the provided interface proxy. More...

virtual bool	GetInterfaceProvidedProxyAccessInfo (const ConnectionIDType connectionID, std::string &endpointInfo)=0
	Get access information of the provided interface proxy. More...

virtual bool	GetInterfaceProvidedProxyAccessInfo (const std::string &clientProcessName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName, std::string &endpointInfo)=0
	Get access information of the provided interface proxy. More...

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

Member Function Documentation

virtual bool mtsManagerGlobalInterface::AddComponent	(	const std::string &	processName,
		const std::string &	componentName
	)

pure virtual

Register component.

Parameters

processName	Name of process
componentName	Name of component

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::AddInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)

pure virtual

Register provided interface. Can be called at run-time.

Parameters

processName	Name of process
componentName	Name of component
interfaceName	Name of provided interface to be added

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::AddInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)

pure virtual

Register required interface. Can be called at run-time.

Parameters

processName	Name of process
componentName	Name of component
interfaceName	Name of required interface to be added

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::AddProcess ( const std::string & processName )

pure virtual

Register process.

Parameters

processName Name of process

Implemented in mtsManagerGlobal.

virtual ConnectionIDType mtsManagerGlobalInterface::Connect	(	const std::string &	requestProcessName,
		const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName
	)

pure virtual

Connect two interfaces.

Parameters

requestProcessName	Name of process that requests this connection
clientProcessName	Name of client process
clientComponentName	Name of client component
clientInterfaceRequiredName	Name of client's required interface
serverProcessName	Name of server process
serverComponentName	Name of server component
serverInterfaceProvidedName	Name of server's provided interface

Returns: Connect session id issued by the global component manager. Session id is used to clean up pending connections (which was requested but not yet established) after timeout. -1 if error occurs, zero or positive value if success

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::ConnectConfirm ( const ConnectionIDType connectionID )

pure virtual

Confirm that connection has been successfully established.

Parameters

connectionID Connection id

Returns: False if connection id is invalid, true otherwise

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::ConnectServerSideInterfaceRequest ( const ConnectionIDType connectionID )

pure virtual

Request the global component manager to connect interfaces at server side.

Parameters

connectionID Connection id issued by GCM

Returns: True if success, false otherwise

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::Disconnect ( const ConnectionIDType connectionID )

pure virtual

Disconnect two interfaces.

Parameters

connectionID Connection id

Returns: true if disconnection request for connection id is accepted, false otherwise

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::Disconnect	(	const std::string &	clientProcessName,
		const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName
	)

pure virtual

Disconnect two interfaces.

Parameters

clientProcessName	Name of client process
clientComponentName	Name of client component
clientInterfaceRequiredName	Name of required interface
serverProcessName	Name of server process
serverComponentName	Name of server component
serverInterfaceProvidedName	Name of provided interface

Returns: True if success, false otherwise

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::FindComponent	(	const std::string &	processName,
		const std::string &	componentName
	)		const

pure virtual

Find component using process name and component name.

Parameters

processName	Name of process
componentName	Name of component

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::FindInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)		const

pure virtual

Find provided interface using process name, component name, and interface name.

Parameters

processName	Name of process
componentName	Name of component
interfaceName	Name of provided interface

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::FindInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)		const

pure virtual

Find required interface using process name, component name, and interface name.

Parameters

processName	Name of process
componentName	Name of component
interfaceName	Name of required interface

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::FindProcess ( const std::string & processName ) const

pure virtual

Find process.

Parameters

processName Name of process

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::GetInterfaceProvidedProxyAccessInfo	(	const ConnectionIDType	connectionID,
		std::string &	endpointInfo
	)

pure virtual

Get access information of the provided interface proxy.

Parameters

connectionID	connection id
endpointInfo	access information of provided interface proxy

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::GetInterfaceProvidedProxyAccessInfo	(	const std::string &	clientProcessName,
		const std::string &	serverProcessName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName,
		std::string &	endpointInfo
	)

pure virtual

Get access information of the provided interface proxy.

Parameters

clientProcessName	Name of client process
serverProcessName	Name of server process
serverComponentName	Name of server component
serverInterfaceProvidedName	Name of server provided interface
endpointInfo	access information of provided interface proxy

Implemented in mtsManagerGlobal.

virtual void mtsManagerGlobalInterface::GetListOfConnections ( std::vector< mtsDescriptionConnection > & list ) const

pure virtual

Get a list of all active connections represented by a set of strings

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::InitiateConnect ( const ConnectionIDType connectionID )

pure virtual

Initiate connection process.

Parameters

connectionID Connection id issued by GCM's Connect().

Returns: True if success, false otherwise

Note: Let a client process initiate connection process. When mtsLocalManager::Connect() is called at the server side, the server process internally calls this method to let the client process initiate connection process.

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::RemoveComponent	(	const std::string &	processName,
		const std::string &	componentName,
		const bool	lock = `true`
	)

pure virtual

Remove component.

Parameters

processName	Name of process
componentName	Name of component

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::RemoveInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName,
		const bool	lock = `true`
	)

pure virtual

Remove provided interface. Can be called at run-time.

Parameters

processName	Name of process
componentName	Name of component
interfaceName	Name of provided interface to be removed

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::RemoveInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName,
		const bool	lock = `true`
	)

pure virtual

Remove required interface. Can be called at run-time.

Parameters

processName	Name of process
componentName	Name of component
interfaceName	Name of required interface to be removed

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::RemoveProcess	(	const std::string &	processName,
		const bool	networkDisconnect
	)

pure virtual

Remove process.

Parameters

processName Name of process

Implemented in mtsManagerGlobal.

virtual bool mtsManagerGlobalInterface::SetInterfaceProvidedProxyAccessInfo	(	const ConnectionIDType	connectionID,
		const std::string &	endpointInfo
	)

pure virtual

Set access information of the provided interface proxy.

Parameters

connectionID	connection id
endpointInfo	Ice proxy access information

Returns: True if success, false otherwise

Note: Required interface proxies use this information to connect to provided interface proxy

Implemented in mtsManagerGlobal.

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

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

Public Member Functions

Member Function Documentation