Classes | Functions
RTC_Utils Namespace Reference

Utility functions for RT-Component. More...

Classes

class  StateHolder
 State holder class. More...
 
class  StateMachine
 State machine class. More...
 

Functions

bool isDataFlowComponent (CORBA::Object_ptr obj)
 Confirm whether specified RT-Component is DataFlowComponent. More...
 
bool isFsmObject (CORBA::Object_ptr obj)
 Confirm whether specified RT-Component is Fsm. More...
 
bool isFsmParticipant (CORBA::Object_ptr obj)
 Confirm whether specified RT-Component is FsmParticipant. More...
 
bool isMultiModeObject (CORBA::Object_ptr obj)
 Confirm whether specified RT-Component is multiModeComponent. More...
 

Detailed Description

Utility functions for RT-Component.

This provides the following utility functions to RT-Component.

Function Documentation

◆ isDataFlowComponent()

bool RTC_Utils::isDataFlowComponent ( CORBA::Object_ptr  obj)

Confirm whether specified RT-Component is DataFlowComponent.

Confirm whether specified RT-Component is DataFlowComponent. DataFlowComponent is a type of the RT-Component which is used when Semantics of ExecutionContext is Periodic Sampled Data Processing.

Parameters
objThe target CORBA object for the investigation
Returns
Investigation result of DataFlowComponent
Since
0.4.0

Definition at line 31 of file RTCUtil.cpp.

◆ isFsmObject()

bool RTC_Utils::isFsmObject ( CORBA::Object_ptr  obj)

Confirm whether specified RT-Component is Fsm.

Confirm whether specified RT-Component is Fsm. Fsm is a type of the RT-Component that is used when Semantics of ExecutionContext is Stimulus Response Processing. It is uset to define the state transition.

Parameters
objThe target CORBA object for the investigation
Returns
Investigation result of Fsm
Since
0.4.0

Definition at line 59 of file RTCUtil.cpp.

◆ isFsmParticipant()

bool RTC_Utils::isFsmParticipant ( CORBA::Object_ptr  obj)

Confirm whether specified RT-Component is FsmParticipant.

Confirm whether specified RT-Component is FsmParticipant. FsmParticipant is a type of the RT-Component which is used when Semantics of ExecutionContext is Stimulus Response Processing. It is used to define the actions in the state.

Parameters
objThe target CORBA object for the investigation
Returns
Investigation result of FsmParticipant
Since
0.4.0

Definition at line 45 of file RTCUtil.cpp.

◆ isMultiModeObject()

bool RTC_Utils::isMultiModeObject ( CORBA::Object_ptr  obj)

Confirm whether specified RT-Component is multiModeComponent.

Confirm whether specified RT-Component is multiModeComponent. multiModeComponent is a type of the RT-Component which is used when Semantics of ExecutionContext is Modes of Operation. It is used to define Mode.

Parameters
objThe target CORBA object for the investigation
Returns
Investigation result of multiModeComponent
Since
0.4.0

Definition at line 73 of file RTCUtil.cpp.



openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:48