Declaration of Manager Component ClientThis class defines the manager component client which is managed by all local component managers (LCMs). An instance of this class is automatically created and gets connected to the manager component server which runs on LCM that runs with the global component manager (GCM). More...

#include <mtsManagerComponentClient.h>

Inheritance diagram for mtsManagerComponentClient:

Classes
struct	GeneralInterfaceStruct

struct	InterfaceComponentFunctionType

struct	InterfaceLCMFunctionType

Public Member Functions
	mtsManagerComponentClient (const std::string &componentName)

	~mtsManagerComponentClient ()

void	Startup (void)

void	Run (void)

void	Cleanup (void)

Public Member Functions inherited from mtsManagerComponentBase
	mtsManagerComponentBase (const std::string &componentName)

virtual	~mtsManagerComponentBase ()

Public Member Functions inherited from mtsTaskFromSignal
	mtsTaskFromSignal (const std::string &name, unsigned int sizeStateTable=256)

virtual	~mtsTaskFromSignal ()

void	Kill (void)

mtsInterfaceRequired *	AddInterfaceRequiredWithoutSystemEventHandlers (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED)

mtsInterfaceProvided *	AddInterfaceProvidedWithoutSystemEvents (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY, bool isProxy=false)

Public Member Functions inherited from mtsTaskContinuous
	mtsTaskContinuous (const std::string &name, unsigned int sizeStateTable=256, bool newThread=true)

	mtsTaskContinuous (const mtsTaskContinuousConstructorArg &arg)

virtual	~mtsTaskContinuous ()

void	Create (void *data=0)

void	Start (void)

void	Suspend (void)

Public Member Functions inherited from mtsTask
	mtsTask (const std::string &name, unsigned int sizeStateTable=256)

virtual	~mtsTask ()

virtual void	OnStartupException (const std::exception &excp)

virtual void	OnRunException (const std::exception &excp)

virtual void	Configure (const std::string &CMN_UNUSED(filename)="")

void	SetInitializationDelay (double delay)

void	Create (void)

double	GetAveragePeriod (void) const

const std::string	GetDefaultStateTableName (void) const

mtsStateTable *	GetDefaultStateTable (void)

virtual bool	WaitToStart (double timeout)

virtual bool	WaitToTerminate (double timeout)

virtual void	WaitForWakeup (void)

virtual void	Wakeup (void)

void	ProcessManagerCommandsIfNotActive ()

bool	CheckForOwnThread (void) const

virtual bool	IsPeriodic (void) const

virtual bool	IsOverranPeriod (void) const

virtual void	ResetOverranPeriod (void)

Public Member Functions inherited from mtsComponent
	mtsComponent (const std::string &deviceName)

virtual	~mtsComponent ()

const std::string &	GetName (void) const

void	GetName (std::string &placeHolder) const

void	SetName (const std::string &componentName)

virtual void	Configure (const std::string &filename="")

bool	CreateAndWait (double timeoutInSeconds)

bool	StartAndWait (double timeoutInSeconds)

bool	KillAndWait (double timeoutInSeconds)

mtsInterfaceProvided *	AddInterfaceProvided (const std::string &interfaceProvidedName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)

CISST_DEPRECATED mtsInterfaceProvided *	AddProvidedInterface (const std::string &interfaceProvidedName)

virtual mtsInterfaceOutput *	AddInterfaceOutput (const std::string &interfaceOutputName)

bool	InterfaceExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

bool	InterfaceProvidedOrOutputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

bool	InterfaceRequiredOrInputExists (const std::string &interfaceName, cmnLogLevel lod=CMN_LOG_LEVEL_INIT_VERBOSE) const

mtsInterfaceProvided *	GetInterfaceProvided (const std::string &interfaceProvidedName) const

mtsInterfaceOutput *	GetInterfaceOutput (const std::string &interfaceOutputName) const

size_t	GetNumberOfInterfacesProvided (void) const

size_t	GetNumberOfInterfacesOutput (void) const

bool	RemoveInterfaceProvided (const std::string &interfaceProvidedName, const bool skipDisconnect=false)

mtsInterfaceRequired *	AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType isRequired=MTS_REQUIRED)

CISST_DEPRECATED mtsInterfaceRequired *	AddRequiredInterface (const std::string &requiredInterfaceName)

virtual mtsInterfaceInput *	AddInterfaceInput (const std::string &interfaceInputName)

const mtsInterfaceProvided *	GetInterfaceProvidedFor (const std::string &interfaceRequiredName)

mtsInterfaceRequired *	GetInterfaceRequired (const std::string &interfaceRequiredName)

mtsInterfaceInput *	GetInterfaceInput (const std::string &interfaceInputName) const

size_t	GetNumberOfInterfacesRequired (void) const

size_t	GetNumberOfInterfacesInput (void) const

bool	RemoveInterfaceRequired (const std::string &interfaceRequiredName, const bool skipDisconnect=false)

const mtsManagerComponentServices *	GetManagerComponentServices (void) const

mtsManagerComponentServices *	GetManagerComponentServices (void)

mtsStateTable *	GetStateTable (const std::string &stateTableName)

bool	AddStateTable (mtsStateTable *existingStateTable, bool addInterfaceProvided=true)

void	UseSeparateLogFileDefault (bool forwardToLogger=true)

void	UseSeparateLogFileDefaultWithDate (bool forwardToLogger=true)

void	UseSeparateLogFile (const std::string &filename, bool forwardToLogger=true)

cmnLogger::StreamBufType *	GetLogMultiplexer (void) const

bool	IsRunning (void) const

bool CISST_DEPRECATED	Running (void) const

bool	IsStarted (void) const

bool	IsTerminated (void) const

bool	IsEndTask (void) const

const mtsComponentState &	GetState (void) const

void	GetState (mtsComponentState &state) const

void	ToStream (std::ostream &outputStream) const

bool	SetReplayMode (void)

bool	SetReplayData (const std::string &stateTableName, const std::string &fileName)

bool	SetReplayTime (const double time)

std::vector< std::string >	GetNamesOfInterfacesProvidedOrOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesProvided (void) const

std::vector< std::string >	GetNamesOfInterfacesOutput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequiredOrInput (void) const

std::vector< std::string >	GetNamesOfInterfacesRequired (void) const

std::vector< std::string >	GetNamesOfInterfacesInput (void) const

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	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 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 Types
typedef cmnNamedMap < InterfaceComponentFunctionType >	InterfaceComponentFunctionMapType

Protected Types inherited from mtsTaskFromSignal
typedef mtsTaskContinuous	BaseType

Protected Types inherited from mtsComponent
typedef cmnNamedMap < mtsStateTable >	StateTableMapType

typedef cmnNamedMap < mtsInterfaceProvided >	InterfacesProvidedMapType

typedef cmnNamedMap < mtsInterfaceOutput >	InterfacesOutputMapType

typedef cmnNamedMap < mtsInterfaceRequired >	InterfacesRequiredMapType

typedef cmnNamedMap < mtsInterfaceInput >	InterfacesInputMapType

Protected Member Functions
void	HandleAddComponentEvent (const mtsDescriptionComponent &component)

void	HandleChangeStateEvent (const mtsComponentStateChange &componentStateChange)

void	HandleAddConnectionEvent (const mtsDescriptionConnection &connection)

void	HandleRemoveConnectionEvent (const mtsDescriptionConnection &connection)

void	HandleMCSReadyEvent (void)

void	HandleChangeStateFromComponent (const mtsComponentStateChange &componentStateChange)

bool	ConnectLocally (const std::string &clientComponentName, const std::string &clientInterfaceName, const std::string &serverComponentName, const std::string &serverInterfaceName, const std::string &clientProcessName="")
	Connect two local interfaces. More...

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

bool	DisconnectCleanup (const std::string &componentName)

bool	AddInterfaceLCM (void)

bool	AddInterfaceComponent (void)

bool	AddNewClientComponent (const std::string &clientComponentName)

bool	CanForwardLog (void) const

bool	ForwardLog (const mtsLogMessage &log) const

bool	Connect (const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)

bool	IsLocalProcess (const std::string &procName) const

void	InterfaceLCMCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)

void	InterfaceLCMCommands_ComponentConfigure (const mtsDescriptionComponent &arg)

void	InterfaceLCMCommands_ComponentConnect (const mtsDescriptionConnection &connectionDescription)

void	InterfaceLCMCommands_ComponentDisconnect (const mtsDescriptionConnection &arg)

void	InterfaceLCMCommands_ComponentStart (const mtsComponentStatusControl &arg)

void	InterfaceLCMCommands_ComponentStop (const mtsComponentStatusControl &arg)

void	InterfaceLCMCommands_ComponentResume (const mtsComponentStatusControl &arg)

void	InterfaceLCMCommands_ComponentGetState (const mtsDescriptionComponent &component, mtsComponentState &state) const

void	InterfaceLCMCommands_GetInterfaceProvidedDescription (const mtsDescriptionInterface &intfc, mtsInterfaceProvidedDescription &description) const

void	InterfaceLCMCommands_GetInterfaceRequiredDescription (const mtsDescriptionInterface &intfc, mtsInterfaceRequiredDescription &description) const

void	InterfaceLCMCommands_LoadLibrary (const std::string &fileName, bool &result) const

void	InterfaceLCMCommands_GetListOfComponentClasses (std::vector< mtsDescriptionComponentClass > &listOfComponentClasses) const

void	InterfaceLCMCommands_SetLogForwarding (const bool &state)

void	InterfaceLCMCommands_GetLogForwardingState (bool &state) const

void	InterfaceLCMCommands_GetAbsoluteTimeInSeconds (double &time) const

void	InterfaceComponentCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)

void	InterfaceComponentCommands_ComponentConfigure (const mtsDescriptionComponent &arg)

void	InterfaceComponentCommands_ComponentConnect (const mtsDescriptionConnection &connectionDescription)

void	InterfaceComponentCommands_ComponentDisconnect (const mtsDescriptionConnection &arg)

void	InterfaceComponentCommands_ComponentStart (const mtsComponentStatusControl &arg)

void	InterfaceComponentCommands_ComponentStop (const mtsComponentStatusControl &arg)

void	InterfaceComponentCommands_ComponentResume (const mtsComponentStatusControl &arg)

void	InterfaceComponentCommands_ComponentGetState (const mtsDescriptionComponent &component, mtsComponentState &state) const

void	InterfaceComponentCommands_GetNamesOfProcesses (std::vector< std::string > &names) const

void	InterfaceComponentCommands_GetNamesOfComponents (const std::string &processName, std::vector< std::string > &names) const

void	InterfaceComponentCommands_GetNamesOfInterfaces (const mtsDescriptionComponent &component, mtsDescriptionInterface &interfaces) const

void	InterfaceComponentCommands_GetListOfConnections (std::vector< mtsDescriptionConnection > &listOfConnections) const

void	InterfaceComponentCommands_GetListOfComponentClasses (const std::string &processName, std::vector< mtsDescriptionComponentClass > &listOfComponentClasses) const

void	InterfaceComponentCommands_GetInterfaceProvidedDescription (const mtsDescriptionInterface &intfc, mtsInterfaceProvidedDescription &description) const

void	InterfaceComponentCommands_GetInterfaceRequiredDescription (const mtsDescriptionInterface &intfc, mtsInterfaceRequiredDescription &description) const

void	InterfaceComponentCommands_LoadLibrary (const mtsDescriptionLoadLibrary &lib, bool &result) const

void	InterfaceComponentCommands_EnableLogForwarding (const std::vector< std::string > &processNames)

void	InterfaceComponentCommands_DisableLogForwarding (const std::vector< std::string > &processNames)

void	InterfaceComponentCommands_GetLogForwardingStates (const stdStringVec &processNames, stdCharVec &states) const

void	InterfaceComponentCommands_GetAbsoluteTimeDiffs (const std::vector< std::string > &processNames, std::vector< double > &processTimes) const

void	GetAbsoluteTimeInSeconds (mtsDouble &time) const

Protected Member Functions inherited from mtsTaskFromSignal
void *	RunInternal (void *argument)

void	PostCommandQueuedMethod (void)

Protected Member Functions inherited from mtsTaskContinuous
virtual void	StartInternal (void)

Protected Member Functions inherited from mtsTask
void	RunEventHandler (void)

void	ChangeStateEventHandler (const mtsComponentState &newState)

mtsExecutionResult	RunEvent (bool check=true)

void	DoRunInternal (void)

virtual void	StartupInternal (void)

virtual void	CleanupInternal (void)

void	Sleep (double timeInSeconds)

mtsStateIndex::TimeTicksType	GetTick (void) const

virtual void	SaveThreadStartData (void *data)

virtual void	SetThreadReturnValue (void *returnValue)

void	ChangeState (mtsComponentState::Enum newState)

bool	WaitForState (mtsComponentState desiredState, double timeout)

Protected Member Functions inherited from mtsComponent
	mtsComponent (void)

	mtsComponent (const mtsComponent &other)

void	Initialize (void)

mtsInterfaceRequired *	AddInterfaceRequiredExisting (const std::string &interfaceRequiredName, mtsInterfaceRequired *interfaceRequired)

mtsInterfaceRequired *	AddInterfaceRequiredUsingMailbox (const std::string &interfaceRequiredName, mtsMailBox *mailBox, mtsRequiredType required)

mtsInterfaceProvided *	AddInterfaceProvidedUsingMailbox (const std::string &interfaceProvidedName, mtsMailBox *mailBox)

mtsInterfaceInput *	AddInterfaceInputExisting (const std::string &interfaceInputName, mtsInterfaceInput *interfaceInput)

mtsInterfaceOutput *	AddInterfaceOutputExisting (const std::string &interfaceOutputName, mtsInterfaceOutput *interfaceOutput)

void	KillSeparateLogFile (void)

size_t	ProcessMailBoxes (InterfacesProvidedMapType &interfaces)

size_t	ProcessQueuedCommands (void)

size_t	ProcessQueuedEvents (void)

mtsInterfaceRequired *	EnableDynamicComponentManagement (void)
	Enable support for dynamic component management services. More...

bool	AddInterfaceInternal (const bool useMangerComponentServices=false)
	Add internal interfaces. More...

void	InterfaceInternalCommands_GetEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)

void	InterfaceInternalCommands_AddObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

void	InterfaceInternalCommands_RemoveEndUserInterface (const mtsEndUserInterfaceArg &argin, mtsEndUserInterfaceArg &argout)

void	InterfaceInternalCommands_RemoveObserverList (const mtsEventHandlerList &argin, mtsEventHandlerList &argout)

void	InterfaceInternalCommands_ComponentCreate (const mtsDescriptionComponent &componentDescription, bool &result)

void	InterfaceInternalCommands_ComponentStartOther (const mtsComponentStatusControl &arg)

Protected Attributes
mtsFunctionRead	GetNamesOfProcesses

bool	MCSReady

InterfaceComponentFunctionMapType	InterfaceComponentFunctionMap

InterfaceLCMFunctionType	InterfaceLCMFunction

struct mtsManagerComponentClient::GeneralInterfaceStruct	GeneralInterface

mtsFunctionWrite	InterfaceLCMEvents_ChangeState

mtsFunctionWrite	InterfaceComponentEvents_AddComponent

mtsFunctionWrite	InterfaceComponentEvents_ChangeState

mtsFunctionWrite	InterfaceComponentEvents_AddConnection

mtsFunctionWrite	InterfaceComponentEvents_RemoveConnection

Protected Attributes inherited from mtsTaskFromSignal
mtsCallableVoidBase *	PostCommandQueuedCallable

Protected Attributes inherited from mtsTaskContinuous
bool	NewThread

bool	CaptureThread

Protected Attributes inherited from mtsTask
osaThread	Thread

double	InitializationDelay

osaMutex	StateChange

osaThreadSignal	StateChangeSignal

mtsStateTable	StateTable

bool	OverranPeriod

void *	ThreadStartData

void *	ReturnValue

mtsCallableVoidBase *	InterfaceProvidedToManagerCallable

mtsInterfaceRequired *	ExecIn

mtsInterfaceProvided *	ExecOut

mtsFunctionVoid	RunEventInternal

bool	RunEventCalled

mtsFunctionWrite	ChangeStateEvent

Protected Attributes inherited from mtsComponent
std::string	Name

mtsComponentState	State

mtsInterfaceProvided *	InterfaceProvidedToManager

bool	UseSeparateLogFileFlag

cmnLogger::StreamBufType *	LoDMultiplexerStreambuf

std::ofstream *	LogFile

StateTableMapType	StateTables

mtsManagerComponentServices *	ManagerComponentServices

mtsFunctionWrite	EventGeneratorChangeState

bool	ReplayMode

InterfacesProvidedMapType	InterfacesProvided

InterfacesOutputMapType	InterfacesOutput

InterfacesRequiredMapType	InterfacesRequired

InterfacesInputMapType	InterfacesInput

Friends
class	mtsManagerLocal

Additional Inherited Members
Public Types inherited from mtsTaskContinuous
typedef mtsTask	BaseType

Public Types inherited from mtsTask
typedef mtsComponent	BaseType

Public Types inherited from mtsComponent
typedef mtsComponent	ThisType

Static Public Member Functions inherited from mtsManagerComponentBase
static bool	IsManagerComponent (const std::string &componentName)

static bool	IsNameOfInternalInterface (const std::string &interfaceName)

static bool	IsManagerComponentServer (const std::string &componentName)

static bool	IsManagerComponentClient (const std::string &componentName)

static bool	IsNameOfInterfaceGCMRequired (const std::string &interfaceName)

static bool	IsNameOfInterfaceGCMProvided (const std::string &interfaceName)

static bool	IsNameOfInterfaceLCMRequired (const std::string &interfaceName)

static bool	IsNameOfInterfaceLCMProvided (const std::string &interfaceName)

static bool	IsNameOfInterfaceComponentRequired (const std::string &interfaceName)

static bool	IsNameOfInterfaceComponentProvided (const std::string &interfaceName)

static bool	IsNameOfInterfaceInternalRequired (const std::string &interfaceName)

static bool	IsNameOfInterfaceInternalProvided (const std::string &interfaceName)

static const std::string	GetNameOfManagerComponentServer (void)

static const std::string	GetNameOfManagerComponentClientFor (const std::string &processName)

static const std::string	GetNameOfInterfaceGCMRequiredFor (const std::string &processName)

static const std::string	GetNameOfInterfaceGCMProvided (void)

static const std::string	GetNameOfInterfaceLCMRequired (void)

static const std::string	GetNameOfInterfaceLCMProvided (void)

static const std::string	GetNameOfInterfaceComponentRequiredFor (const std::string &componentName)

static const std::string	GetNameOfInterfaceComponentProvided (void)

static const std::string	GetNameOfInterfaceInternalRequired (void)

static const std::string	GetNameOfInterfaceInternalProvided (void)

Static Public Attributes inherited from mtsTask
static std::runtime_error	UnknownException

Detailed Description

Declaration of Manager Component Client

This class defines the manager component client which is managed by all local component managers (LCMs). An instance of this class is automatically created and gets connected to the manager component server which runs on LCM that runs with the global component manager (GCM).

This component has two sets of interfaces, one for communication with the manager component server and the other one for command exchange between other manager component clients.

Note: Related classes: mtsManagerComponentBase, mtsManagerComponentServer

Member Typedef Documentation

typedef cmnNamedMap<InterfaceComponentFunctionType> mtsManagerComponentClient::InterfaceComponentFunctionMapType

protected

Constructor & Destructor Documentation

mtsManagerComponentClient::mtsManagerComponentClient ( const std::string & componentName )

mtsManagerComponentClient::~mtsManagerComponentClient ( )

Member Function Documentation

bool mtsManagerComponentClient::AddInterfaceComponent ( void )

protected

bool mtsManagerComponentClient::AddInterfaceLCM ( void )

protected

bool mtsManagerComponentClient::AddNewClientComponent ( const std::string & clientComponentName )

protected

Create a new set of function objects, add a new instance of InterfaceComponent's required interface to this component, and connect it to InterfaceInternal's provided interface

bool mtsManagerComponentClient::CanForwardLog ( void ) const

protected

If MCC can forward log messages to MCS. This returns false until MCC gets connected to MCS.

void mtsManagerComponentClient::Cleanup ( void )

virtual

Virtual method that gets overloaded, and is run after the component gets killed using Kill() method.

Reimplemented from mtsManagerComponentBase.

bool mtsManagerComponentClient::Connect	(	const std::string &	clientComponentName,
		const std::string &	clientInterfaceRequiredName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceProvidedName
	)

protected

bool mtsManagerComponentClient::ConnectLocally	(	const std::string &	clientComponentName,
		const std::string &	clientInterfaceName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceName,
		const std::string &	clientProcessName = `""`
	)

protected

Connect two local interfaces.

Parameters

clientComponentName	Name of client component
clientInterfaceName	Name of required/input interface
serverComponentName	Name of server component
serverInterfaceName	Name of provided/output interface
clientProcessName	Name of client process (ignored in standalone configuration, used in networked configuration)

Returns: true if successful, false otherwise

Note: It is assumed that the two components are in the same process.

bool mtsManagerComponentClient::DisconnectCleanup ( const std::string & componentName )

protected

bool mtsManagerComponentClient::DisconnectLocally	(	const std::string &	clientComponentName,
		const std::string &	clientInterfaceName,
		const std::string &	serverComponentName,
		const std::string &	serverInterfaceName
	)

protected

bool mtsManagerComponentClient::ForwardLog ( const mtsLogMessage & log ) const

protected

Support for system-wide thread-safe logging. Forward logs to MCS.

void mtsManagerComponentClient::GetAbsoluteTimeInSeconds ( mtsDouble & time ) const

protected

void mtsManagerComponentClient::HandleAddComponentEvent ( const mtsDescriptionComponent & component )

protected

void mtsManagerComponentClient::HandleAddConnectionEvent ( const mtsDescriptionConnection & connection )

protected

void mtsManagerComponentClient::HandleChangeStateEvent ( const mtsComponentStateChange & componentStateChange )

protected

void mtsManagerComponentClient::HandleChangeStateFromComponent ( const mtsComponentStateChange & componentStateChange )

protected

void mtsManagerComponentClient::HandleMCSReadyEvent ( void )

protected

void mtsManagerComponentClient::HandleRemoveConnectionEvent ( const mtsDescriptionConnection & connection )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentConfigure ( const mtsDescriptionComponent & arg )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentConnect ( const mtsDescriptionConnection & connectionDescription )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentCreate	(	const mtsDescriptionComponent &	componentDescription,
		bool &	result
	)

protected

Commands for InterfaceComponent's provided interface

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentDisconnect ( const mtsDescriptionConnection & arg )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentGetState	(	const mtsDescriptionComponent &	component,
		mtsComponentState &	state
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentResume ( const mtsComponentStatusControl & arg )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentStart ( const mtsComponentStatusControl & arg )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_ComponentStop ( const mtsComponentStatusControl & arg )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_DisableLogForwarding ( const std::vector< std::string > & processNames )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_EnableLogForwarding ( const std::vector< std::string > & processNames )

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetAbsoluteTimeDiffs	(	const std::vector< std::string > &	processNames,
		std::vector< double > &	processTimes
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetInterfaceProvidedDescription	(	const mtsDescriptionInterface &	intfc,
		mtsInterfaceProvidedDescription &	description
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetInterfaceRequiredDescription	(	const mtsDescriptionInterface &	intfc,
		mtsInterfaceRequiredDescription &	description
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetListOfComponentClasses	(	const std::string &	processName,
		std::vector< mtsDescriptionComponentClass > &	listOfComponentClasses
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetListOfConnections ( std::vector< mtsDescriptionConnection > & listOfConnections ) const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetLogForwardingStates	(	const stdStringVec &	processNames,
		stdCharVec &	states
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetNamesOfComponents	(	const std::string &	processName,
		std::vector< std::string > &	names
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetNamesOfInterfaces	(	const mtsDescriptionComponent &	component,
		mtsDescriptionInterface &	interfaces
	)		const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_GetNamesOfProcesses ( std::vector< std::string > & names ) const

protected

void mtsManagerComponentClient::InterfaceComponentCommands_LoadLibrary	(	const mtsDescriptionLoadLibrary &	lib,
		bool &	result
	)		const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentConfigure ( const mtsDescriptionComponent & arg )

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentConnect ( const mtsDescriptionConnection & connectionDescription )

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentCreate	(	const mtsDescriptionComponent &	componentDescription,
		bool &	result
	)

protected

Commands for InterfaceLCM's provided interface

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentDisconnect ( const mtsDescriptionConnection & arg )

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentGetState	(	const mtsDescriptionComponent &	component,
		mtsComponentState &	state
	)		const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentResume ( const mtsComponentStatusControl & arg )

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentStart ( const mtsComponentStatusControl & arg )

protected

void mtsManagerComponentClient::InterfaceLCMCommands_ComponentStop ( const mtsComponentStatusControl & arg )

protected

void mtsManagerComponentClient::InterfaceLCMCommands_GetAbsoluteTimeInSeconds ( double & time ) const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_GetInterfaceProvidedDescription	(	const mtsDescriptionInterface &	intfc,
		mtsInterfaceProvidedDescription &	description
	)		const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_GetInterfaceRequiredDescription	(	const mtsDescriptionInterface &	intfc,
		mtsInterfaceRequiredDescription &	description
	)		const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_GetListOfComponentClasses ( std::vector< mtsDescriptionComponentClass > & listOfComponentClasses ) const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_GetLogForwardingState ( bool & state ) const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_LoadLibrary	(	const std::string &	fileName,
		bool &	result
	)		const

protected

void mtsManagerComponentClient::InterfaceLCMCommands_SetLogForwarding ( const bool & state )

protected

bool mtsManagerComponentClient::IsLocalProcess ( const std::string & procName ) const

protected

void mtsManagerComponentClient::Run ( void )

virtual

Pure virtual method that gets overloaded to run the actual task.

Reimplemented from mtsManagerComponentBase.

void mtsManagerComponentClient::Startup ( void )

virtual

Virtual method that gets overloaded, and is run before the component is started.

Implements mtsManagerComponentBase.

Friends And Related Function Documentation

friend class mtsManagerLocal

friend

Member Data Documentation

struct mtsManagerComponentClient::GeneralInterfaceStruct mtsManagerComponentClient::GeneralInterface

protected

mtsFunctionRead mtsManagerComponentClient::GetNamesOfProcesses

protected

Get a list of all processes running in the system

mtsFunctionWrite mtsManagerComponentClient::InterfaceComponentEvents_AddComponent

protected

Event generators for InterfaceComponent's provided interface

mtsFunctionWrite mtsManagerComponentClient::InterfaceComponentEvents_AddConnection

protected

mtsFunctionWrite mtsManagerComponentClient::InterfaceComponentEvents_ChangeState

protected

mtsFunctionWrite mtsManagerComponentClient::InterfaceComponentEvents_RemoveConnection

protected

InterfaceComponentFunctionMapType mtsManagerComponentClient::InterfaceComponentFunctionMap

protected

mtsFunctionWrite mtsManagerComponentClient::InterfaceLCMEvents_ChangeState

protected

Event generators for InterfaceLCM's provided interface

InterfaceLCMFunctionType mtsManagerComponentClient::InterfaceLCMFunction

protected

bool mtsManagerComponentClient::MCSReady

protected

If MCS is ready

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

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

Classes

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation