ERC CISST - cisst software

---

mtsComponentState Class Reference

#include <mtsComponentState.h>

Collaboration diagram for mtsComponentState:

[legend]List of all members.

---

Detailed Description

The possible component states:

CONSTRUCTED -- Initial state set by mtsTask constructor. INITIALIZING -- Set by mtsComponent::Create. The task stays in this state until the thread calls mtsTask::RunInternal, which calls mtsTask::StartupInternal and the user-supplied mtsTask::Startup. If a new thread is created, the call to mtsTask::RunInternal happens some time after the call to mtsTask::Create. READY -- Set by mtsTask::StartupInternal. This means that the task is ready to be used (i.e., all interfaces have been initialized). Also, a task can return to the READY state (from the ACTIVE state) in response to a call to mtsTask::Suspend. ACTIVE -- Set by mtsTask::Start. This is the normal running state, where the task is calling the user-supplied mtsTask::Run method. FINISHING -- Set by mtsTask::Kill. If the mtsTask::Run method is currently executing, it will finish, but no further calls will be made. The task will then call mtsTask::CleanupInternal, which calls the user-supplied mtsTask::Cleanup. The state will then be set to FINISHED. FINISHED -- The task has finished.

Definition at line 55 of file mtsComponentState.h.

Public Types

• enum Enum
• typedef mtsComponentState ThisType

Public Member Functions

• mtsComponentState (void)
• mtsComponentState (const Enum &value)
• const ThisType & operator= (const Enum &value)
• void ToStream (std::ostream &outputStream) const
• bool operator== (const ThisType &state) const
• bool operator!= (const ThisType &state) const
• bool operator< (const ThisType &state) const
• bool operator<= (const ThisType &state) const
• bool operator> (const ThisType &state) const
• bool operator>= (const ThisType &state) const
• Enum GetState (void)

Static Public Member Functions

• static const std::string & ToString (const Enum &value)

Protected Attributes

• Enum Value

---

Member Typedef Documentation

typedef mtsComponentState mtsComponentState::ThisType

Defined this type

Definition at line 59 of file mtsComponentState.h.

---

Member Enumeration Documentation

enum mtsComponentState::Enum

Possible states

Definition at line 62 of file mtsComponentState.h.

---

Constructor & Destructor Documentation

mtsComponentState::mtsComponentState

(

void

)

Default constructor, set value to CONSTRUCTED.

mtsComponentState::mtsComponentState

(

const Enum &

value

)

Constructor from a given value.

---

Member Function Documentation

const ThisType& mtsComponentState::operator=

(

const Enum &

value

)

Assignement operator.

void mtsComponentState::ToStream

(

std::ostream &

outputStream

)

const

Send a human readable description of the state.

Referenced by operator<<().

static const std::string& mtsComponentState::ToString

(

const Enum &

value

)

[static]

Get a human readable description for any state

bool mtsComponentState::operator==

(

const ThisType &

state

)

const

Equality operators

bool mtsComponentState::operator<

(

const ThisType &

state

)

const

Lesser or equal operators

bool mtsComponentState::operator>

(

const ThisType &

state

)

const

Greater or equal operators

Enum mtsComponentState::GetState

(

void

)

[inline]

Getter of current state

Definition at line 98 of file mtsComponentState.h.

---

Member Data Documentation

Enum mtsComponentState::Value [protected]

Value of this state

Definition at line 104 of file mtsComponentState.h.

---

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

• mtsComponentState.h

---