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

RTM Namespace Reference


Classes

interface  RTCBase
 RTCBase interface. More...

struct  TimedState
struct  TimedShort
struct  TimedLong
struct  TimedUShort
struct  TimedULong
struct  TimedFloat
struct  TimedDouble
struct  TimedChar
struct  TimedBoolean
struct  TimedOctet
struct  TimedString
struct  TimedShortSeq
struct  TimedLongSeq
struct  TimedUShortSeq
struct  TimedULongSeq
struct  TimedFloatSeq
struct  TimedDoubleSeq
struct  TimedCharSeq
struct  TimedBooleanSeq
struct  TimedOctetSeq
struct  TimedStringSeq
struct  PortProfile
 A structure of InPort/OutPort profile. More...

interface  InPort
 Input port interface. More...

exception  InPort::Disconnected
 Disconnected exception. More...

interface  RTCManager
 RTComponent manager interface. More...

interface  RTComponent
 RTComponent interface. More...

exception  RTComponent::IllegalTransition
 Illegal transition exception. More...

exception  RTComponent::NoSuchName
 No such name exception. More...

struct  SubscriberProfile
 SubscriberProfile. 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< RTCBaseRTCBaseList
 RTCbase list.

typedef string SubscriptionID
 Subscription ID.

typedef sequence< InPortInPortList
 InPort list.

typedef sequence< PortProfilePortProfileList
 InPort/OutPort profile list.

typedef sequence< string > ComponentFactoryList
typedef sequence< RTComponentRTComponentList
 RTComponent list.

typedef short SubscriptionType
 SubscriptionType definition Subscription type to OutPort. OPS stands for OutPort Subscription.

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

const SubscriptionType OPS_ONCE = 0
 Subscribe Once.

const SubscriptionType OPS_PERIODIC = 1
 Get data periodic.

const SubscriptionType OPS_NEW = 2
 Get data if updated.

const SubscriptionType OPS_TRIGGERED = 3
 Get data if triggered.

const SubscriptionType OSP_PERIODIC_NEW = 4
 Get data periodic if updated.

const SubscriptionType OPS_NEW_PERIODIC = 5
 Get data if updated and periodic.

const SubscriptionType OPS_PERIODIC_TRIGGERED = 6
 Get data periodic if triggerd.

const SubscriptionType OPS_TRIGGERRED_PERIODIC = 7
 Get data if triggered and periodic.

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<string> RTM::ComponentFactoryList
 

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<PortProfile> RTM::PortProfileList
 

InPort/OutPort profile list.

typedef sequence<RTCBase> RTM::RTCBaseList
 

RTCbase list.

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;

typedef string RTM::SubscriptionID
 

Subscription ID.

Unique ID for subscription. Usually UUID is used.

typedef short RTM::SubscriptionType
 

SubscriptionType definition Subscription type to OutPort. OPS stands for OutPort Subscription.


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

const SubscriptionType RTM::OPS_NEW = 2
 

Get data if updated.

Get data every time a new data is available in outport

const SubscriptionType RTM::OPS_NEW_PERIODIC = 5
 

Get data if updated and periodic.

Get data every time a new data is available in outport but not faster than a given pace : server leads synchro

const SubscriptionType RTM::OPS_ONCE = 0
 

Subscribe Once.

Get only one data asynchronously present, this is to ensure that the client will not block while the servant is acquiring the data (may be we need one more option to specify if we want the data now or the next new data)

const SubscriptionType RTM::OPS_PERIODIC = 1
 

Get data periodic.

Get data at regular pace

const SubscriptionType RTM::OPS_PERIODIC_TRIGGERED = 6
 

Get data periodic if triggerd.

Same as OSP_PERIODIC_NEW but the "new" condition is replaced by the "trigger" condition

const SubscriptionType RTM::OPS_TRIGGERED = 3
 

Get data if triggered.

Get data every time a condition is reached (like "is > 2.0", we need to define a condition definition language but it's not yet urgent)

const SubscriptionType RTM::OPS_TRIGGERRED_PERIODIC = 7
 

Get data if triggered and periodic.

Same as OSP_TRIGGERED_PERIODIC but the "new" condition is replaced by the "trigger" condition

const SubscriptionType RTM::OSP_PERIODIC_NEW = 4
 

Get data periodic if updated.

Get data at regular pace only if a new data is available in the outport : especially useful for analog data : client leads synchro

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 Thu Dec 16 15:29:34 2004 for OpenRTM by doxygen 1.3.6