ERC CISST - cisst software

---

mtsTaskFromSignal Class Reference
[Multi Task Support]

Inheritance diagram for mtsTaskFromSignal:

[legend]Collaboration diagram for mtsTaskFromSignal:

[legend]List of all members.

---

Detailed Description

Definition at line 41 of file mtsTaskFromSignal.h.

Public Member Functions

• mtsTaskFromSignal (const std::string &name, unsigned int sizeStateTable=256)
• virtual ~mtsTaskFromSignal ()
• void Kill (void)
• mtsInterfaceRequired * AddInterfaceRequired (const std::string &interfaceRequiredName, mtsRequiredType required=MTS_REQUIRED)
• mtsInterfaceProvided * AddInterfaceProvided (const std::string &newInterfaceName, mtsInterfaceQueueingPolicy queueingPolicy=MTS_COMPONENT_POLICY)

Protected Types

• typedef mtsTaskContinuous BaseType

Protected Member Functions

• void * RunInternal (void *argument)
• void PostCommandQueuedMethod (void)

Protected Attributes

• mtsCallableVoidBase * PostCommandQueuedCallable

---

Constructor & Destructor Documentation

mtsTaskFromSignal::mtsTaskFromSignal	(	const std::string &	name,
		unsigned int	sizeStateTable = 256
	)

Create a task with name 'name' and set the state table size.

Parameters:

	name	The name of the task
	sizeStateTable	The history size of the state table

Note:

See note in mtsTask regarding length of string name.

See also:

mtsTask, mtsTaskContinuous, mtsTaskPeriodic

virtual mtsTaskFromSignal::~mtsTaskFromSignal

(

)

[inline, virtual]

Default Destructor.

Definition at line 74 of file mtsTaskFromSignal.h.

---

Member Function Documentation

void* mtsTaskFromSignal::RunInternal

(

void *

argument

)

[protected, virtual]

The member function that is passed as 'start routine' argument for thread creation.

Reimplemented from mtsTaskContinuous.

void mtsTaskFromSignal::PostCommandQueuedMethod

(

void

)

[protected]

Method used to by the callable PostCommandQueuedCallable to wake up the thread when any queued command or event is sent

void mtsTaskFromSignal::Kill

(

void

)

[virtual]

End the task

Reimplemented from mtsTaskContinuous.

mtsInterfaceRequired* mtsTaskFromSignal::AddInterfaceRequired	(	const std::string &	interfaceRequiredName,
		mtsRequiredType	required = MTS_REQUIRED
	)			[virtual]

Add a required interface. This interface will later on be connected to another task and use the provided interface of the other task. The required interface created also contains a list of event handlers to be used as observers.

Reimplemented from mtsTask.

mtsInterfaceProvided* mtsTaskFromSignal::AddInterfaceProvided	(	const std::string &	newInterfaceName,
		mtsInterfaceQueueingPolicy	queueingPolicy = MTS_COMPONENT_POLICY
	)			[virtual]

Method to add a provided interface to the component. This method is virtual so that mtsTaskBase can redefine it and generate the appropriate type of interface, i.e. mtsInterfaceProvided as opposed to mtsInterfaceProvided for mtsComponent.

Reimplemented from mtsTask.

---

Member Data Documentation

mtsCallableVoidBase* mtsTaskFromSignal::PostCommandQueuedCallable [protected]

Callable created around the PostCommandQueuedMethod.

Definition at line 57 of file mtsTaskFromSignal.h.

---

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

• mtsTaskFromSignal.h

---