ERC CISST - cisst software

---

mtsManagerGlobalInterface Class Reference

Inheritance diagram for mtsManagerGlobalInterface:

[legend]Collaboration diagram for mtsManagerGlobalInterface:

[legend]List of all members.

---

Detailed Description

Definition at line 44 of file mtsManagerGlobalInterface.h.

Public Member Functions

• virtual bool AddProcess (const std::string &processName)=0

  Register process.
  

• virtual bool FindProcess (const std::string &processName) const=0

  Find process.
  

• virtual bool RemoveProcess (const std::string &processName)=0

  Remove process.
  

• virtual bool AddComponent (const std::string &processName, const std::string &componentName)=0

  Register component.
  

• virtual bool FindComponent (const std::string &processName, const std::string &componentName) const=0

  Find component using process name and component name.
  

• virtual bool RemoveComponent (const std::string &processName, const std::string &componentName)=0

  Remove component.
  

• virtual bool AddInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName, const bool isProxyInterface)=0

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

• virtual bool AddInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName, const bool isProxyInterface)=0

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

• 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.
  

• 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.
  

• virtual bool RemoveInterfaceProvidedOrOutput (const std::string &processName, const std::string &componentName, const std::string &interfaceName)=0

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

• virtual bool RemoveInterfaceRequiredOrInput (const std::string &processName, const std::string &componentName, const std::string &interfaceName)=0

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

• virtual int 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.
  

• virtual bool ConnectConfirm (unsigned int connectionSessionID)=0

  Confirm that connection has been successfully established.
  

• 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.
  

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

---

Member Function Documentation

virtual bool mtsManagerGlobalInterface::AddProcess

(

const std::string &

processName

)

[pure virtual]

Register process.

Parameters:

processName

Name of process

virtual bool mtsManagerGlobalInterface::FindProcess

(

const std::string &

processName

)

const [pure virtual]

Find process.

Parameters:

processName

Name of process

virtual bool mtsManagerGlobalInterface::RemoveProcess

(

const std::string &

processName

)

[pure virtual]

Remove process.

Parameters:

processName

Name of process

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

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

virtual bool mtsManagerGlobalInterface::RemoveComponent	(	const std::string &	processName,
		const std::string &	componentName
	)			[pure virtual]

Remove component.

Parameters:

	processName	Name of process
	componentName	Name of component

virtual bool mtsManagerGlobalInterface::AddInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName,
		const bool	isProxyInterface
	)			[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
	isProxyInterface	True if interface added is a proxy interface

virtual bool mtsManagerGlobalInterface::AddInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName,
		const bool	isProxyInterface
	)			[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
	isProxyInterface	True if interface added is a proxy interface

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

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

virtual bool mtsManagerGlobalInterface::RemoveInterfaceProvidedOrOutput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)			[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

virtual bool mtsManagerGlobalInterface::RemoveInterfaceRequiredOrInput	(	const std::string &	processName,
		const std::string &	componentName,
		const std::string &	interfaceName
	)			[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

virtual int 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

virtual bool mtsManagerGlobalInterface::ConnectConfirm

(

unsigned int

connectionSessionID

)

[pure virtual]

Confirm that connection has been successfully established.

Parameters:

connectionSessionID

Connection id

Returns:

False if connection id is invalid, true otherwise

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

virtual void mtsManagerGlobalInterface::GetListOfConnections

(

std::vector< mtsDescriptionConnection > &

list

)

const [pure virtual]

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

---

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

• mtsManagerGlobalInterface.h

---