#include <mtsComponentViewer.h>

Inheritance diagram for mtsComponentViewer:

Public Member Functions
	mtsComponentViewer (const std::string &name)

virtual	~mtsComponentViewer ()

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

virtual void	Startup (void)

virtual void	Run (void)

virtual void	Cleanup (void)

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)

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
enum	BorderType { BORDER_NONE, BORDER_SINGLE, BORDER_DOUBLE }

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 *	ReadFromUDrawGraph (int)

virtual void	ProcessResponse (void)

bool	ConnectToUDrawGraph (void)

virtual void	SendAllInfo (void)

void	ActivateMenuItems (void)

std::string	GetComponentInUDrawGraphFormat (const std::string &processName, const std::string &componentName, const mtsComponentState &componentState) const

std::string	GetStateInUDrawGraphFormat (const mtsComponentState &componentState) const

std::string	GetConnectionInUDrawGraphFormat (const mtsDescriptionConnection &connection) const

void	ChangeComponentBorder (const std::string &processName, const std::string &componentName, BorderType border)

virtual void	AddComponentHandler (const mtsDescriptionComponent &componentInfo)

virtual void	ChangeStateHandler (const mtsComponentStateChange &componentStateChange)

virtual void	AddConnectionHandler (const mtsDescriptionConnection &connectionInfo)

virtual void	RemoveConnectionHandler (const mtsDescriptionConnection &connectionInfo)

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)

Static Protected Member Functions
static void	ParseArgs (const std::string &input, std::string &arg1, std::string &arg2)

static bool	ParseProcessAndComponent (const std::string &input, std::string &processName, std::string &componentName)

Protected Attributes
osaPipeExec	UDrawPipe

bool	UDrawPipeConnected

std::string	UDrawResponse

bool	ShowProxies

bool	ConnectionStarted

mtsDescriptionConnection	ConnectionRequest

osaThread	ReaderThread

osaThreadSignal	ReadyToRead

bool	ReaderThreadFinished

bool	WaitingForResponse

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

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 Attributes inherited from mtsTask
static std::runtime_error	UnknownException

Member Enumeration Documentation

enum mtsComponentViewer::BorderType

protected

Enumerator
BORDER_NONE
BORDER_SINGLE
BORDER_DOUBLE

Constructor & Destructor Documentation

mtsComponentViewer::mtsComponentViewer ( const std::string & name )

virtual mtsComponentViewer::~mtsComponentViewer ( )

virtual

Member Function Documentation

void mtsComponentViewer::ActivateMenuItems ( void )

protected

virtual void mtsComponentViewer::AddComponentHandler ( const mtsDescriptionComponent & componentInfo )

protectedvirtual

virtual void mtsComponentViewer::AddConnectionHandler ( const mtsDescriptionConnection & connectionInfo )

protectedvirtual

void mtsComponentViewer::ChangeComponentBorder	(	const std::string &	processName,
		const std::string &	componentName,
		BorderType	border
	)

protected

virtual void mtsComponentViewer::ChangeStateHandler ( const mtsComponentStateChange & componentStateChange )

protectedvirtual

virtual void mtsComponentViewer::Cleanup ( void )

virtual

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

Reimplemented from mtsComponent.

virtual void mtsComponentViewer::Configure ( const std::string & CMN_UNUSEDfilename )

inlinevirtual

Virtual method that gets called when the task/interface needs to be configured. Should it take XML info??

Reimplemented from mtsTask.

bool mtsComponentViewer::ConnectToUDrawGraph ( void )

protected

std::string mtsComponentViewer::GetComponentInUDrawGraphFormat	(	const std::string &	processName,
		const std::string &	componentName,
		const mtsComponentState &	componentState
	)		const

protected

std::string mtsComponentViewer::GetConnectionInUDrawGraphFormat ( const mtsDescriptionConnection & connection ) const

protected

std::string mtsComponentViewer::GetStateInUDrawGraphFormat ( const mtsComponentState & componentState ) const

protected

static void mtsComponentViewer::ParseArgs	(	const std::string &	input,
		std::string &	arg1,
		std::string &	arg2
	)

staticprotected

static bool mtsComponentViewer::ParseProcessAndComponent	(	const std::string &	input,
		std::string &	processName,
		std::string &	componentName
	)

staticprotected

virtual void mtsComponentViewer::ProcessResponse ( void )

protectedvirtual

void* mtsComponentViewer::ReadFromUDrawGraph ( int )

protected

virtual void mtsComponentViewer::RemoveConnectionHandler ( const mtsDescriptionConnection & connectionInfo )

protectedvirtual

virtual void mtsComponentViewer::Run ( void )

virtual

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

Implements mtsTask.

virtual void mtsComponentViewer::SendAllInfo ( void )

protectedvirtual

virtual void mtsComponentViewer::Startup ( void )

virtual

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

Reimplemented from mtsComponent.

Member Data Documentation

mtsDescriptionConnection mtsComponentViewer::ConnectionRequest

protected

bool mtsComponentViewer::ConnectionStarted

protected

osaThread mtsComponentViewer::ReaderThread

protected

bool mtsComponentViewer::ReaderThreadFinished

protected

osaThreadSignal mtsComponentViewer::ReadyToRead

protected

bool mtsComponentViewer::ShowProxies

protected

osaPipeExec mtsComponentViewer::UDrawPipe

protected

bool mtsComponentViewer::UDrawPipeConnected

protected

std::string mtsComponentViewer::UDrawResponse

protected

bool mtsComponentViewer::WaitingForResponse

protected

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

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

Public Member Functions

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation