Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

RTM Namespace Reference


Classes

interface  RTCBase
 RTCBase interface. More...
interface  InPort
 Input port interface. More...
struct  RTCFactory
interface  RTCManager
 RTComponent manager interface. More...
interface  RTComponent
 RTComponent interface. More...
interface  OutPort
 Output interface. More...
struct  RTCProfile
 Component profile structure. More...
struct  RTCManagerProfile
struct  NamedValue
 named value structure More...
struct  Time
 Time value structure. More...

Typedefs

typedef sequence< InPortInPortList
 InPort list.
typedef sequence< RTCFactoryRTCFactoryList
typedef sequence< RTComponentRTComponentList
 RTComponent list.
typedef sequence< OutPortOutPortList
 OutPort list.
typedef sequence< octet > RTCIconImage
 Component icon image type decleration.
typedef short RtmRes
 Return value of standard RTComponent operation.
typedef sequence< NamedValueNVList
 named value structure sequence

Enumerations

enum  RTComponentType { STATIC, UNIQUE, COMMUTATIVE }
 Component type. More...
enum  RTCActivityType { PERIODIC, SPORADIC, EVENT_DRIVEN }
 Component activity type. More...
enum  RTCLangType { COMPILE, SCRIPT }
 Component description language type. More...

Variables

interface typedef sequence<
RTCBase
RTCBaseList
 RTCbase list.
const RtmRes RTM_OK = 0
 The operation has returned normally.
const RtmRes RTM_ERR = 1
 The operation has returned with error.
const RtmRes RTM_WARNING = 2
 The operation has returned with fatal error.
const RtmRes RTM_FATAL_ERR = 4
 The operation has returned with fatal error.


Typedef Documentation

typedef sequence<InPort> RTM::InPortList
 

InPort list.

typedef sequence<NamedValue> RTM::NVList
 

named value structure sequence

This sequence store named value

typedef sequence<OutPort> RTM::OutPortList
 

OutPort list.

typedef sequence<RTCFactory> RTM::RTCFactoryList
 

typedef sequence<octet> RTM::RTCIconImage
 

Component icon image type decleration.

typedef sequence<RTComponent> RTM::RTComponentList
 

RTComponent list.

typedef short RTM::RtmRes
 

Return value of standard RTComponent operation.

If operation have no specific return value, operation will return RtmRes type return value. RtmRes have the following pre-defined values: RTM_OK , RTM_ERR , RTM_WARNING , RTM_FATAL_ERR.

const RtmRes RTM_OK = 0; const RtmRes RTM_ERR = 1; const RtmRes RTM_WARNING = 2; const RtmRes RTM_FATAL_ERR = 4;


Enumeration Type Documentation

enum RTM::RTCActivityType
 

Component activity type.

Enumeration values:
PERIODIC  PERIDIC activity. Periodic working activity. Period time is constant. For only realtime OS.
SPORADIC  SPORADIC activity. Sporadic working activity. Activity works depending on outside event or hardware event.
EVENT_DRIVEN  EVENT_DRIVEN activity. Activity works as event driven task. Events will raised from other component, application software, etc...

enum RTM::RTCLangType
 

Component description language type.

Enumeration values:
COMPILE  Component is programmed in compile language.
SCRIPT  Component is programmed in script language.

enum RTM::RTComponentType
 

Component type.

Enumeration values:
STATIC  STATIC Component. Statically instantiated and no dynamic instance.
UNIQUE  UNIQUE Component. Dynamically instantiated component. But each component should be handle a unique it. For example, the compopnent is statically bound to hardaware device.
COMMUTATIVE  COMMUTATIVE Component. Dynamically instantiated component. Each component is commutative. For example, logic components are commutative.


Variable Documentation

interface typedef sequence<RTCBase> RTM::RTCBaseList
 

RTCbase list.

const RtmRes RTM::RTM_ERR = 1
 

The operation has returned with error.

const RtmRes RTM::RTM_FATAL_ERR = 4
 

The operation has returned with fatal error.

const RtmRes RTM::RTM_OK = 0
 

The operation has returned normally.

const RtmRes RTM::RTM_WARNING = 2
 

The operation has returned with fatal error.


Generated on Fri Jan 5 15:43:50 2007 for OpenRTM by  doxygen 1.4.1