OpenRTM  1.0.0
Classes | Typedefs | Enumerations
RTC Namespace Reference

Classes

struct  Time
 
struct  TimedState
 
struct  TimedShort
 
struct  TimedLong
 
struct  TimedUShort
 
struct  TimedULong
 
struct  TimedFloat
 
struct  TimedDouble
 
struct  TimedChar
 
struct  TimedWChar
 
struct  TimedBoolean
 
struct  TimedOctet
 
struct  TimedString
 
struct  TimedWString
 
struct  TimedShortSeq
 
struct  TimedLongSeq
 
struct  TimedUShortSeq
 
struct  TimedULongSeq
 
struct  TimedFloatSeq
 
struct  TimedDoubleSeq
 
struct  TimedCharSeq
 
struct  TimedWCharSeq
 
struct  TimedBooleanSeq
 
struct  TimedOctetSeq
 
struct  TimedStringSeq
 
struct  TimedWStringSeq
 
interface  ComponentAction
 ComponentAction. More...
 
interface  LightweightRTObject
 LightweightRTObject. More...
 
interface  ExecutionContext
 ExecutionContext. More...
 
interface  DataFlowComponentAction
 DataFlowComponentAction. More...
 
interface  DataFlowComponent
 dataFlowComponent More...
 
interface  Fsm
 fsm More...
 
interface  FsmParticipantAction
 FsmParticipantAction. More...
 
interface  FsmParticipant
 
interface  Mode
 Mode. More...
 
interface  ModeCapable
 ModeCapable. More...
 
interface  MultiModeComponentAction
 MultiModeComponentAction. More...
 
interface  MultiModeObject
 
struct  PortInterfaceProfile
 PortInterfaceProfile. More...
 
struct  ConnectorProfile
 ConnectorProfile. More...
 
struct  PortProfile
 PortProfile. More...
 
struct  ExecutionContextProfile
 
interface  FsmObject
 FsmObject. More...
 
struct  FsmBehaviorProfile
 FsmBehaviorProfile. More...
 
struct  FsmProfile
 FsmProfile. More...
 
interface  FsmService
 FsmService. More...
 
struct  ComponentProfile
 ComponentProfile. More...
 
interface  PortService
 PortService. More...
 
interface  ExecutionContextService
 ExecutionContextService. More...
 
interface  RTObject
 RTObject. More...
 

Typedefs

typedef
EXECUTION_HANDLE_TYPE_NATIVE 
ExecutionContextHandle_t
 ExecutionContextHandle_t. More...
 
typedef
SDOPackage::UniqueIdentifier 
UniqueIdentifier
 
typedef SDOPackage::NVList NVList
 
typedef sequence
< ExecutionContext
ExecutionContextList
 
typedef sequence
< PortInterfaceProfile
PortInterfaceProfileList
 
typedef sequence< PortServicePortServiceList
 
typedef sequence< RTObjectRTCList
 
typedef sequence
< ConnectorProfile
ConnectorProfileList
 
typedef sequence< PortProfilePortProfileList
 
typedef sequence
< ExecutionContextProfile
ExecutionContextProfileList
 
typedef sequence
< FsmBehaviorProfile
FsmBehaviorProfileList
 
typedef sequence
< ComponentProfile
ComponentProfileList
 
typedef sequence
< ExecutionContextService
ExecutionContextServiceList
 

Enumerations

enum  ReturnCode_t {
  RTC_OK, RTC_ERROR, BAD_PARAMETER, UNSUPPORTED,
  OUT_OF_RESOURCES, PRECONDITION_NOT_MET
}
 ReturnCode_t. More...
 
enum  LifeCycleState { CREATED_STATE, INACTIVE_STATE, ACTIVE_STATE, ERROR_STATE }
 LifeCycleState. More...
 
enum  ExecutionKind { PERIODIC, EVENT_DRIVEN, OTHER }
 ExecutionKind. More...
 
enum  PortInterfacePolarity { PROVIDED, REQUIRED }
 PortInterfacePolarity. More...
 

Typedef Documentation

ExecutionContextHandle_t.

Description

This data type represents the association between an RTC and an ExecutionContext in which it participates.

Semantics

This is an opaque DataType. It has no attributes or operations.

typedef sequence<PortProfile> RTC::PortProfileList
typedef sequence<PortService> RTC::PortServiceList
typedef sequence<RTObject> RTC::RTCList

Enumeration Type Documentation

ExecutionKind.

Description

The ExecutionKind enumeration defines the execution semantics (see Section 5.3) of the RTCs that participate in an execution context.

Enumerator
PERIODIC 

PERIODIC.

Description

The participant RTCs are executing according to periodic sampled data semantics (see Section 5.3.1).

EVENT_DRIVEN 

EVENT_DRIVEN.

Description

The participant RTCs are executing according to stimulus response semantics (see Section 5.3.2).

OTHER 

OTHER.

Description

The participant RTCs are executing according to some semantics not defined by this specification.

LifeCycleState.

Description

LifeCycleState is an enumeration of the states in the lifecycle above.

Enumerator
CREATED_STATE 

CREATED.

Description

The RTC object has been instantiated but not yet fully initialized.

INACTIVE_STATE 

INACTIVE.

Description

The RTC is Alive but is not being invoked in any execution context (see Section 5.2.2.5), regardless of whether the context is Running or not.

Semantics

An instance of this state exists for each execution context in which the RTC participates. If the RTC does not participate in any execution context, a single instance of this state exists.

ACTIVE_STATE 

ACTIVE.

Description

The RTC is Alive and will be invoked in the execution context if the context is Running.

Semantics

An instance of this state exists for each execution context in which the RTC participates. If the RTC does not participate in any execution context, this state shall never be observed.

ERROR_STATE 

ERROR.

Description

The RTC has encountered a problem in a given execution context and cannot continue functioning in that context without being reset.

PortInterfacePolarity.

Description

The PortInterfacePolarity enumeration identifies exposed interface instances as provided or required.

Enumerator
PROVIDED 

PROVIDED.

Description

The target interface is provided as an output by the target port.

REQUIRED 

REQUIRED.

Description

The target interface is required as an input by the target port.

ReturnCode_t.

A number of operations in this specification will need to report potential error conditions to their clients. This task shall be accomplished by means of operation "return codes" of type ReturnCode_t

Operations in the PIM that do not return a value of type ReturnCode_t shall report errors in the following ways, depending on their return type:

  • If an operation normally returns a positive numerical value (such as get_rate, see [OMG RTC 1.0 Section 5.2.2.6.4]), it shall indicate failure by returning a negative value.
  • If an operation normally returns an object reference (such as RTObject::get_component_profile, see [OMG RTC 1.0 Section 5.4.2.2.1]), it shall indicate failure by returning a nil reference.
Parameters
RTC_OKThe operation completed successfully.
RTC_ERRORThe operation failed with a generic, unspecified error.
BAD_PARAMETERThe operation failed because an illegal argument was passed to it.
UNSUPPORTEDThe operation is unsupported by the implementation (e.g., it belongs to a compliance point that is not implemented).
OUT_OF_RESOURCESThe target of the operation ran out of the resources needed to complete the operation.
PRECONDITION_NOT_META pre-condition for the operation was not met.
Enumerator
RTC_OK 
RTC_ERROR 
BAD_PARAMETER 
UNSUPPORTED 
OUT_OF_RESOURCES 
PRECONDITION_NOT_MET