#include <mtsManagerLocal.h>

Inheritance diagram for mtsManagerLocal:

Public Member Functions
void	Cleanup (void)
	Cleanup. Left in the public API for backwards compatibility. Client code should not call this method directly, and should instead call DeleteInstance prior to quitting. DeleteInstance calls this method before deleting the singleton.
const std::string CISST_DEPRECATED	GetName (void) const
const mtsManagerComponentServices *	GetManagerComponentServices () const
const ManagerLocalComponent *	GetLoggerServices () const
mtsComponent *	CreateComponentDynamically (const std::string &className, const std::string &componentName, const std::string &constructorArgSerialized)
	Create a component. Does not add it to the local component manager. In this method, componentName is only used if constructorArgSerialized is an empty string.
mtsComponent *	CreateComponentDynamically (const std::string &className, const mtsGenericObject &constructorArg)
	Create a component. Does not add it to the local component manager. In this method, the component name is obtained from constructorArg.
bool	AddComponent (mtsComponent *component)
	Add a component to the component manager.
bool CISST_DEPRECATED	AddTask (mtsTask *component)
bool CISST_DEPRECATED	AddDevice (mtsComponent *component)
bool	RemoveComponent (mtsComponent *component)
	Remove component from component manager.
bool	RemoveComponent (const std::string &componentName)
size_t	RemoveAllUserComponents (void)
	Remove all user components from this local component manager.
mtsComponent *	GetComponent (const std::string &componentName) const
	Retrieve a component by name.
mtsTask *	GetComponentAsTask (const std::string &componentName) const
mtsComponent CISST_DEPRECATED *	GetDevice (const std::string &deviceName)
mtsTask CISST_DEPRECATED *	GetTask (const std::string &taskName)
bool	FindComponent (const std::string &componentName) const
	Check if a component exists by its name.
bool	WaitForStateAll (mtsComponentState desiredState, double timeout=3.0 *cmn_minute) const
void	CreateAll (void)
	Create all components. If a component is of type mtsTask, mtsTask::Create() is called internally.
bool	CreateAllAndWait (double timeoutInSeconds)
void	StartAll (void)
	Start all components. If a component is of type mtsTask, mtsTask::Start() is called internally.
bool	StartAllAndWait (double timeoutInSeconds)
void	KillAll (void)
	Stop all components. If a component is of type mtsTask, mtsTask::Kill() is called internally.
bool	KillAllAndWait (double timeoutInSeconds)
bool	Connect (const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)
	Connect two local interfaces.
bool	Connect (const std::string &clientProcessName, const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverProcessName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)
	Connect two remote interfaces.
bool	Disconnect (const ConnectionIDType connectionID)
bool	Disconnect (const std::string &clientComponentName, const std::string &clientInterfaceRequiredName, const std::string &serverComponentName, const std::string &serverInterfaceProvidedName)
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)
const std::string	GetProcessName (void) const
void	GetNamesOfProcesses (std::vector< std::string > &namesOfProcesses) const
std::vector< std::string >	GetNamesOfComponents (void) const
void	GetNamesOfComponents (std::vector< std::string > &namesOfComponents) const
void	GetNamesOfComponents (const std::string &processName, std::vector< std::string > &namesOfComponents) 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	GetNamesOfInterfaces (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
bool	GetDescriptionsOfInterfaces (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
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
const osaTimeServer &	GetTimeServer (void) const
void	SetMainThreadId (void)
void	SetMainThreadId (const osaThreadId &threadId)
osaThreadId	GetMainThreadId (void) const
void	GetNamesOfCommands (std::vector< std::string > &namesOfCommands, const std::string &componentName, const std::string &providedInterfaceName)
void	GetNamesOfEventGenerators (std::vector< std::string > &namesOfEventGenerators, const std::string &componentName, const std::string &providedInterfaceName)
void	GetNamesOfFunctions (std::vector< std::string > &namesOfFunctions, const std::string &componentName, const std::string &requiredInterfaceName)
void	GetNamesOfEventHandlers (std::vector< std::string > &namesOfEventHandlers, const std::string &componentName, const std::string &requiredInterfaceName)
void	GetDescriptionOfCommand (std::string &description, const std::string &componentName, const std::string &providedInterfaceName, const std::string &commandName)
void	GetDescriptionOfEventGenerator (std::string &description, const std::string &componentName, const std::string &providedInterfaceName, const std::string &eventGeneratorName)
void	GetDescriptionOfFunction (std::string &description, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &functionName)
void	GetDescriptionOfEventHandler (std::string &description, const std::string &componentName, const std::string &requiredInterfaceName, const std::string &eventHandlerName)
std::string CISST_DEPRECATED	GetIPAddress (void) const
bool	IsValidComponentTag (const std::string &tag) const
bool	IsValidInterfaceTag (const std::string &tag) const
void	AddValidComponentTag (const std::string &tag)
void	AddValidInterfaceTag (const std::string &tag)
const std::set< std::string > &	GetValidComponentTags (void) const
const std::set< std::string > &	GetValidInterfaceTags (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	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

Static Public Member Functions
static mtsManagerLocal *	GetInstance (void)
static void	DeleteInstance (void)
	DeleteInstance. Since a local component manager is a singleton, and demand-created by the first caller of GetInstance, the destructor will never be called unless an application calls this method just prior to quitting. GetInstance should NOT be used again after this method is called. This method calls Cleanup from its implementation, so a separate call to Cleanup is unnecessary.
static std::vector< std::string >	GetIPAddressList (void)
static void	GetIPAddressList (std::vector< std::string > &ipAddresses)
static bool CISST_DEPRECATED	IsLogAllowed (void)
static bool	IsLogForwardingEnabled (void)
static void	SetLogForwarding (bool activate)
static void	GetLogForwardingState (bool &state)
static bool	GetLogForwardingState (void)
static void	LogDispatcher (const char *str, int len)

Protected Member Functions
	mtsManagerLocal (void)
virtual	~mtsManagerLocal ()
void	Initialize (void)
bool	CreateManagerComponent (void)
	Create internal manager component.
void	DestroyManagerComponent (void)
	Destroy internal manager component.
void	GetInterfaceProvidedDescription (const std::string &componentName, const std::string &interfaceName, mtsInterfaceProvidedDescription &interfaceProvidedDescription)
void	GetInterfaceRequiredDescription (const std::string &componentName, const std::string &interfaceName, mtsInterfaceRequiredDescription &interfaceRequiredDescription)
void	SetupSystemLogger (void)

Protected Attributes
ManagerLocalComponent *	LocalComponent

Constructor & Destructor Documentation

◆ mtsManagerLocal()

mtsManagerLocal::mtsManagerLocal ( void )

protected

Protected constructor (singleton)

◆ ~mtsManagerLocal()

virtual mtsManagerLocal::~mtsManagerLocal ( )

protectedvirtual

Destructor. Includes OS-specific cleanup.

Member Function Documentation

◆ AddComponent()

bool mtsManagerLocal::AddComponent ( mtsComponent * component )

Add a component to the component manager.

Parameters

component Component instance to be added

◆ AddDevice()

bool CISST_DEPRECATED mtsManagerLocal::AddDevice ( mtsComponent * component )

◆ AddTask()

bool CISST_DEPRECATED mtsManagerLocal::AddTask ( mtsTask * component )

◆ AddValidComponentTag()

void mtsManagerLocal::AddValidComponentTag ( const std::string & tag )

◆ AddValidInterfaceTag()

void mtsManagerLocal::AddValidInterfaceTag ( const std::string & tag )

◆ Cleanup()

void mtsManagerLocal::Cleanup ( void )

Cleanup. Left in the public API for backwards compatibility. Client code should not call this method directly, and should instead call DeleteInstance prior to quitting. DeleteInstance calls this method before deleting the singleton.

◆ Connect() [1/2]

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

Connect two local interfaces.

Parameters

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

Returns: True if success, false otherwise

Note: If connection is established successfully, this information is reported to the global component manager (the local component manager does not keep any connection information).

◆ Connect() [2/2]

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

Connect two remote 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

Note: If connection is established successfully, this information is reported to the global component manager. Since connection between two interfaces should be established twice–once in the client process and once in the server process–there are two internal connection management methods: ConnectClientSideInterface() and ConnectServerSideInterface(). ConnectClientSideInterface() is always executed first and calls ConnectServerSideInterface() internally in a blocking way (i.e., it waits for ConnectServerSideInterface() to finish). Connection request can be made by any process – server process, client process, or even third process – and the result should be the same regardless the request process. If this method is called against two local interfaces, the other Connect() method is internally called instead.

◆ CreateAll()

void mtsManagerLocal::CreateAll ( void )

Create all components. If a component is of type mtsTask, mtsTask::Create() is called internally.

◆ CreateAllAndWait()

bool mtsManagerLocal::CreateAllAndWait ( double timeoutInSeconds )

Call CreateAll method followed by WaitForStateAll.

◆ CreateComponentDynamically() [1/2]

mtsComponent * mtsManagerLocal::CreateComponentDynamically	(	const std::string &	className,
		const mtsGenericObject &	constructorArg )

Create a component. Does not add it to the local component manager. In this method, the component name is obtained from constructorArg.

◆ CreateComponentDynamically() [2/2]

mtsComponent * mtsManagerLocal::CreateComponentDynamically	(	const std::string &	className,
		const std::string &	componentName,
		const std::string &	constructorArgSerialized )

Create a component. Does not add it to the local component manager. In this method, componentName is only used if constructorArgSerialized is an empty string.

◆ CreateManagerComponent()

bool mtsManagerLocal::CreateManagerComponent ( void )

protected

Create internal manager component.

◆ DeleteInstance()

void mtsManagerLocal::DeleteInstance ( void )

static

DeleteInstance. Since a local component manager is a singleton, and demand-created by the first caller of GetInstance, the destructor will never be called unless an application calls this method just prior to quitting. GetInstance should NOT be used again after this method is called. This method calls Cleanup from its implementation, so a separate call to Cleanup is unnecessary.

◆ DestroyManagerComponent()

void mtsManagerLocal::DestroyManagerComponent ( void )

protected

Destroy internal manager component.

◆ Disconnect() [1/3]

bool mtsManagerLocal::Disconnect ( const ConnectionIDType connectionID )

Disconnect two interfaces

◆ Disconnect() [2/3]

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

◆ Disconnect() [3/3]

bool mtsManagerLocal::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 )

◆ FindComponent()

bool mtsManagerLocal::FindComponent ( const std::string & componentName ) const

Check if a component exists by its name.

◆ GetComponent()

mtsComponent * mtsManagerLocal::GetComponent ( const std::string & componentName ) const

Retrieve a component by name.

◆ GetComponentAsTask()

mtsTask * mtsManagerLocal::GetComponentAsTask ( const std::string & componentName ) const

◆ GetDescriptionOfCommand()

void mtsManagerLocal::GetDescriptionOfCommand	(	std::string &	description,
		const std::string &	componentName,
		const std::string &	providedInterfaceName,
		const std::string &	commandName )

Get description of a command in a provided interface

◆ GetDescriptionOfEventGenerator()

void mtsManagerLocal::GetDescriptionOfEventGenerator	(	std::string &	description,
		const std::string &	componentName,
		const std::string &	providedInterfaceName,
		const std::string &	eventGeneratorName )

Get description of a event generator in a provided interface

◆ GetDescriptionOfEventHandler()

void mtsManagerLocal::GetDescriptionOfEventHandler	(	std::string &	description,
		const std::string &	componentName,
		const std::string &	requiredInterfaceName,
		const std::string &	eventHandlerName )

Get description of a function in a required interface

◆ GetDescriptionOfFunction()

void mtsManagerLocal::GetDescriptionOfFunction	(	std::string &	description,
		const std::string &	componentName,
		const std::string &	requiredInterfaceName,
		const std::string &	functionName )

Get description of a function in a required interface

◆ GetDescriptionsOfComponents()

std::vector< mtsDescriptionComponent > mtsManagerLocal::GetDescriptionsOfComponents ( const std::string & processName = "" ) const

◆ GetDescriptionsOfInterfaces() [1/2]

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

inline

◆ GetDescriptionsOfInterfaces() [2/2]

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

◆ GetDevice()

mtsComponent CISST_DEPRECATED * mtsManagerLocal::GetDevice ( const std::string & deviceName )

◆ GetInstance()

mtsManagerLocal * mtsManagerLocal::GetInstance ( void )

static

Get a singleton object of local component manager.

◆ GetInterfaceProvidedDescription() [1/3]

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

inline

◆ GetInterfaceProvidedDescription() [2/3]

void mtsManagerLocal::GetInterfaceProvidedDescription	(	const std::string &	componentName,
		const std::string &	interfaceName,
		mtsInterfaceProvidedDescription &	interfaceProvidedDescription )

protected

Get information about provided interface

◆ GetInterfaceProvidedDescription() [3/3]

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

◆ GetInterfaceRequiredDescription() [1/3]

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

inline

◆ GetInterfaceRequiredDescription() [2/3]

void mtsManagerLocal::GetInterfaceRequiredDescription	(	const std::string &	componentName,
		const std::string &	interfaceName,
		mtsInterfaceRequiredDescription &	interfaceRequiredDescription )

protected

Extract all the information on a required interface such as function objects and event handlers with arguments serialized

◆ GetInterfaceRequiredDescription() [3/3]

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

◆ GetIPAddress()

std::string CISST_DEPRECATED mtsManagerLocal::GetIPAddress ( void ) const

inline

Return IP address of this process

◆ GetIPAddressList() [1/2]

void mtsManagerLocal::GetIPAddressList ( std::vector< std::string > & ipAddresses )

static

◆ GetIPAddressList() [2/2]

std::vector< std::string > mtsManagerLocal::GetIPAddressList ( void )

static

Return a list of all IP addresses detected on this machine.

◆ GetListOfComponentClasses()

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

◆ GetListOfConnections()

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

◆ GetLogForwardingState() [1/2]

void mtsManagerLocal::GetLogForwardingState ( bool & state )

static

Get whether system-wide logging is enabled or not

◆ GetLogForwardingState() [2/2]

bool mtsManagerLocal::GetLogForwardingState ( void )

static

◆ GetLoggerServices()

const ManagerLocalComponent * mtsManagerLocal::GetLoggerServices ( ) const

Return the logger services. This is a method so that we can later add thread-safety.

◆ GetMainThreadId()

osaThreadId mtsManagerLocal::GetMainThreadId ( void ) const

inline

Return main thread id.

◆ GetManagerComponentServices()

const mtsManagerComponentServices * mtsManagerLocal::GetManagerComponentServices ( ) const

Return the ManagerComponentServices. This is a method so that we can later add thread-safety.

◆ GetName()

const std::string CISST_DEPRECATED mtsManagerLocal::GetName ( void ) const

inline

Returns name of this local component manager (for mtsProxyBaseCommon.h)

◆ GetNamesOfCommands()

void mtsManagerLocal::GetNamesOfCommands	(	std::vector< std::string > &	namesOfCommands,
		const std::string &	componentName,
		const std::string &	providedInterfaceName )

Get names of all commands in a provided interface

◆ GetNamesOfComponents() [1/3]

void mtsManagerLocal::GetNamesOfComponents	(	const std::string &	processName,
		std::vector< std::string > &	namesOfComponents ) const

◆ GetNamesOfComponents() [2/3]

void mtsManagerLocal::GetNamesOfComponents ( std::vector< std::string > & namesOfComponents ) const

◆ GetNamesOfComponents() [3/3]

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

Enumerate all the names of components added

◆ GetNamesOfEventGenerators()

void mtsManagerLocal::GetNamesOfEventGenerators	(	std::vector< std::string > &	namesOfEventGenerators,
		const std::string &	componentName,
		const std::string &	providedInterfaceName )

Get names of all event generators in a provided interface

◆ GetNamesOfEventHandlers()

void mtsManagerLocal::GetNamesOfEventHandlers	(	std::vector< std::string > &	namesOfEventHandlers,
		const std::string &	componentName,
		const std::string &	requiredInterfaceName )

Get names of all event handlers in a required interface

◆ GetNamesOfFunctions()

void mtsManagerLocal::GetNamesOfFunctions	(	std::vector< std::string > &	namesOfFunctions,
		const std::string &	componentName,
		const std::string &	requiredInterfaceName )

Get names of all functions in a required interface

◆ GetNamesOfInterfaces() [1/2]

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

inline

◆ GetNamesOfInterfaces() [2/2]

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

◆ GetNamesOfProcesses()

void mtsManagerLocal::GetNamesOfProcesses ( std::vector< std::string > & namesOfProcesses ) const

Get names of all processes

◆ GetProcessName()

const std::string mtsManagerLocal::GetProcessName ( void ) const

inline

Returns name of this local component manager

◆ GetTask()

mtsTask CISST_DEPRECATED * mtsManagerLocal::GetTask ( const std::string & taskName )

◆ GetTimeServer()

const osaTimeServer & mtsManagerLocal::GetTimeServer ( void ) const

Return a reference to the time server.

◆ GetValidComponentTags()

const std::set< std::string > & mtsManagerLocal::GetValidComponentTags ( void ) const

◆ GetValidInterfaceTags()

const std::set< std::string > & mtsManagerLocal::GetValidInterfaceTags ( void ) const

◆ Initialize()

void mtsManagerLocal::Initialize ( void )

protected

Initialization

◆ IsLogAllowed()

bool CISST_DEPRECATED mtsManagerLocal::IsLogAllowed ( void )

static

Check if further logs are allowed (used in mtsTask); this could be moved to cmnLogger.

◆ IsLogForwardingEnabled()

bool mtsManagerLocal::IsLogForwardingEnabled ( void )

static

Is system-wide thread-safe logging enabled?

◆ IsValidComponentTag()

bool mtsManagerLocal::IsValidComponentTag ( const std::string & tag ) const

◆ IsValidInterfaceTag()

bool mtsManagerLocal::IsValidInterfaceTag ( const std::string & tag ) const

◆ KillAll()

void mtsManagerLocal::KillAll ( void )

Stop all components. If a component is of type mtsTask, mtsTask::Kill() is called internally.

◆ KillAllAndWait()

bool mtsManagerLocal::KillAllAndWait ( double timeoutInSeconds )

Call KillAll method followed by WaitForStateAll.

◆ LogDispatcher()

void mtsManagerLocal::LogDispatcher	(	const char *	str,
		int	len )

static

Callback function for system-wide thread-safe logging

◆ RemoveAllUserComponents()

size_t mtsManagerLocal::RemoveAllUserComponents ( void )

Remove all user components from this local component manager.

Returns: the number of user components removed.

◆ RemoveComponent() [1/2]

bool mtsManagerLocal::RemoveComponent ( const std::string & componentName )

◆ RemoveComponent() [2/2]

bool mtsManagerLocal::RemoveComponent ( mtsComponent * component )

Remove component from component manager.

◆ SetLogForwarding()

void mtsManagerLocal::SetLogForwarding ( bool activate )

static

Enable or disable system-wide thread-safe logging. As of 6/2026, system-wide logging will only be initialized on first call to this method.

◆ SetMainThreadId() [1/2]

void mtsManagerLocal::SetMainThreadId ( const osaThreadId & threadId )

inline

Set main thread id based on the passed parameter. In most situations, it is not necessary to call this function because the main thread id is initialized in GetInstance.

◆ SetMainThreadId() [2/2]

void mtsManagerLocal::SetMainThreadId ( void )

inline

Set main thread id based on the current thread. In most situations, it is not necessary to call this function because the main thread id is initialized in GetInstance.

◆ SetupSystemLogger()

void mtsManagerLocal::SetupSystemLogger ( void )

protected

Set up system logger that allows collecting system-wide logs across network

◆ StartAll()

void mtsManagerLocal::StartAll ( void )

Start all components. If a component is of type mtsTask, mtsTask::Start() is called internally.

◆ StartAllAndWait()

bool mtsManagerLocal::StartAllAndWait ( double timeoutInSeconds )

Call StartAll method followed by WaitForStateAll.

◆ WaitForStateAll()

bool mtsManagerLocal::WaitForStateAll	(	mtsComponentState	desiredState,
		double	timeout = 3.0 *cmn_minute ) const

Wait until all components reach a certain state. If all components have reach the given state within the time alloted, the method returns true.

Member Data Documentation

◆ LocalComponent

ManagerLocalComponent* mtsManagerLocal::LocalComponent

protected

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

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ mtsManagerLocal()

◆ ~mtsManagerLocal()

Member Function Documentation

◆ AddComponent()

◆ AddDevice()

◆ AddTask()

◆ AddValidComponentTag()

◆ AddValidInterfaceTag()

◆ Cleanup()

◆ Connect() [1/2]

◆ Connect() [2/2]

◆ CreateAll()

◆ CreateAllAndWait()

◆ CreateComponentDynamically() [1/2]

◆ CreateComponentDynamically() [2/2]

◆ CreateManagerComponent()

◆ DeleteInstance()

◆ DestroyManagerComponent()

◆ Disconnect() [1/3]

◆ Disconnect() [2/3]

◆ Disconnect() [3/3]

◆ FindComponent()

◆ GetComponent()

◆ GetComponentAsTask()

◆ GetDescriptionOfCommand()

◆ GetDescriptionOfEventGenerator()

◆ GetDescriptionOfEventHandler()

◆ GetDescriptionOfFunction()

◆ GetDescriptionsOfComponents()

◆ GetDescriptionsOfInterfaces() [1/2]

◆ GetDescriptionsOfInterfaces() [2/2]

◆ GetDevice()

◆ GetInstance()

◆ GetInterfaceProvidedDescription() [1/3]

◆ GetInterfaceProvidedDescription() [2/3]

◆ GetInterfaceProvidedDescription() [3/3]

◆ GetInterfaceRequiredDescription() [1/3]

◆ GetInterfaceRequiredDescription() [2/3]

◆ GetInterfaceRequiredDescription() [3/3]

◆ GetIPAddress()

◆ GetIPAddressList() [1/2]

◆ GetIPAddressList() [2/2]

◆ GetListOfComponentClasses()

◆ GetListOfConnections()

◆ GetLogForwardingState() [1/2]

◆ GetLogForwardingState() [2/2]

◆ GetLoggerServices()

◆ GetMainThreadId()

◆ GetManagerComponentServices()

◆ GetName()

◆ GetNamesOfCommands()

◆ GetNamesOfComponents() [1/3]

◆ GetNamesOfComponents() [2/3]

◆ GetNamesOfComponents() [3/3]

◆ GetNamesOfEventGenerators()

◆ GetNamesOfEventHandlers()

◆ GetNamesOfFunctions()

◆ GetNamesOfInterfaces() [1/2]

◆ GetNamesOfInterfaces() [2/2]

◆ GetNamesOfProcesses()

◆ GetProcessName()

◆ GetTask()

◆ GetTimeServer()

◆ GetValidComponentTags()

◆ GetValidInterfaceTags()

◆ Initialize()

◆ IsLogAllowed()

◆ IsLogForwardingEnabled()

◆ IsValidComponentTag()

◆ IsValidInterfaceTag()

◆ KillAll()

◆ KillAllAndWait()

◆ LogDispatcher()

◆ RemoveAllUserComponents()

◆ RemoveComponent() [1/2]