メインページ | ネームスペース一覧 | クラス階層 | 構成 | ファイル一覧 | ネームスペースメンバ | 構成メンバ

ネームスペース RTM


構成

interface  RTCBase
 RTCBase インターフェース. [詳細]

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
 InPort/OutPort のプロファイル構造体. [詳細]

interface  InPort
 InPort インターフェース. [詳細]

exception  InPort::Disconnected
 切断例外. [詳細]

interface  RTCManager
 RTComponent インターフェース. [詳細]

interface  RTComponent
 RTComponent インターフェース. [詳細]

exception  RTComponent::IllegalTransition
 不正状態遷移例外. [詳細]

exception  RTComponent::NoSuchName
 不正な名前指定例外. [詳細]

struct  SubscriberProfile
 SubscriberProfile. [詳細]

interface  OutPort
 OutPort インターフェース. [詳細]

struct  RTCProfile
 コンポーネントプロファイル構造体 [詳細]

struct  RTCManagerProfile
struct  NamedValue
 名前付き変数値. [詳細]

struct  Time
 時刻構造体 [詳細]


型定義

typedef sequence< RTCBaseRTCBaseList
 RTCBase リスト.

typedef string SubscriptionID
 Subscription ID.

typedef sequence< InPortInPortList
 InPort のリスト.

typedef sequence< PortProfilePortProfileList
 InPort/OutPort のプロファイルのリスト.

typedef sequence< string > ComponentFactoryList
typedef sequence< RTComponentRTComponentList
 RTComponent リスト.

typedef short SubscriptionType
 SubscriptionType 定義 OutPort に対する Subscription 型。OPS は OutPort Subscription を意味する。.

typedef sequence< OutPortOutPortList
 OutPort のリスト.

typedef sequence< octet > RTCIconImage
 コンポーネントのアイコンイメージ宣言

typedef short RtmRes
 RTComponent オペレーションの戻り値.

typedef sequence< NamedValueNVList
 名前付き変数シーケンス.


列挙型

enum  RTComponentType { STATIC, UNIQUE, COMMUTATIVE }
 コンポーネントタイプ 生成されるコンポーネントのインスタンスの形式。 [詳細]

enum  RTCActivityType { PERIODIC, SPORADIC, EVENT_DRIVEN }
 コンポーネントアクティビティタイプ 生成されるコンポーネントのアクティビティの形式。 [詳細]

enum  RTCLangType { COMPILE, SCRIPT }
 コンポーネント記述言語型 コンポーネントを記述する言語の型 [詳細]


変数

const SubscriptionType OPS_ONCE = 0
 一度だけデータを取得する。

const SubscriptionType OPS_PERIODIC = 1
 一定周期でデータ送信

const SubscriptionType OPS_NEW = 2
 データ更新時にデータ送信

const SubscriptionType OPS_TRIGGERED = 3
 トリガによりデータ送信

const SubscriptionType OSP_PERIODIC_NEW = 4
 一定周期でデータ更新時のみ送信

const SubscriptionType OPS_NEW_PERIODIC = 5
 データ更新時に送信・一定周期で送信

const SubscriptionType OPS_PERIODIC_TRIGGERED = 6
 一定周期でトリガ時のみ送信

const SubscriptionType OPS_TRIGGERRED_PERIODIC = 7
 トリガ時に送信・一定周期で送信

const RtmRes RTM_OK = 0
 オペレーションは正常終了した

const RtmRes RTM_ERR = 1
 オペレーションはエラー終了した

const RtmRes RTM_WARNING = 2
 オペレーションは警告終了した

const RtmRes RTM_FATAL_ERR = 4
 オペレーションは致命的エラー終了した


型定義

typedef sequence<string> RTM::ComponentFactoryList
 

typedef sequence<InPort> RTM::InPortList
 

InPort のリスト.

typedef sequence<NamedValue> RTM::NVList
 

名前付き変数シーケンス.

任意の型の値を名前付きで格納する構造体のシーケンス

typedef sequence<OutPort> RTM::OutPortList
 

OutPort のリスト.

typedef sequence<PortProfile> RTM::PortProfileList
 

InPort/OutPort のプロファイルのリスト.

typedef sequence<RTCBase> RTM::RTCBaseList
 

RTCBase リスト.

typedef sequence<octet> RTM::RTCIconImage
 

コンポーネントのアイコンイメージ宣言

typedef sequence<RTComponent> RTM::RTComponentList
 

RTComponent リスト.

typedef short RTM::RtmRes
 

RTComponent オペレーションの戻り値.

戻り値に特定の型を持たないオペレーションは RtmRes 型の戻り値を返す。 戻り値には、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.

サブスクライブに対してユニークなID。通常はUUIDを用いる。

typedef short RTM::SubscriptionType
 

SubscriptionType 定義 OutPort に対する Subscription 型。OPS は OutPort Subscription を意味する。.


列挙型

enum RTM::RTCActivityType
 

コンポーネントアクティビティタイプ 生成されるコンポーネントのアクティビティの形式。

列挙型の値:
PERIODIC  コンポーネントの活動は一定周期で行われる。 ただし、動作周期を守れるか否かは、OSに依存である。 リアルタイムOS(ART-LINUX)を使用すれば一定周期動作を行わせることは 可能であるが、非リアルタイムOSでは厳密な周期動作をさせることは不可能。

SPORADIC  コンポーネントの活動の周期は一定ではないが、繰り返し行われる。

EVENT_DRIVEN  外部からのオペレーションにより受動的に動作します。

enum RTM::RTCLangType
 

コンポーネント記述言語型 コンポーネントを記述する言語の型

列挙型の値:
COMPILE  コンポーネントはコンパイル型言語で記述される。

SCRIPT  コンポーネントはスクリプト言語で記述される。

enum RTM::RTComponentType
 

コンポーネントタイプ 生成されるコンポーネントのインスタンスの形式。

列挙型の値:
STATIC  コンポーネントはマネージャに登録されると同時にインスタンス化され 、新たに生成することはできない。ハードウエアに密接に関係するコンポーネン ト等はこのタイプにするとハードウエアとコンポーネントの対応がとりやすい。

UNIQUE  コンポーネントは動的に生成・削除するができるが、component0 と component1 は異なる内部状態を持ち交換可能ではない。

COMMUTATIVE  コンポーネントは、互いに交換可能。 ソフトウエアのロジックのみのコンポーネントはこのタイプになる。


変数

const SubscriptionType RTM::OPS_NEW = 2
 

データ更新時にデータ送信

OutPortのデータが更新され次第すぐにサブスクライバにデータが送信される。

const SubscriptionType RTM::OPS_NEW_PERIODIC = 5
 

データ更新時に送信・一定周期で送信

データ更新時にすぐにデータは送信されるが、それ以降はデータが更新され 続ける限りは一定周期で送信で送信される。

const SubscriptionType RTM::OPS_ONCE = 0
 

一度だけデータを取得する。

データを非同期的に1度だけ取得する。その際クライアントはサーバントが 取得している最中ブロックされない。 最近のデータを取得するのか、最新のデータを取得するのかをオプションで 指定する必要があるかもしれない。

const SubscriptionType RTM::OPS_PERIODIC = 1
 

一定周期でデータ送信

指定した周期でデータ送信をサブスクライバに送信する。

const SubscriptionType RTM::OPS_PERIODIC_TRIGGERED = 6
 

一定周期でトリガ時のみ送信

OPS_PERIODIC_NEW の送信条件がトリガに変わるだけで、そのほかの動作は OPS_PERIODIC_NEW と同じになる。

const SubscriptionType RTM::OPS_TRIGGERED = 3
 

トリガによりデータ送信

予め設定されたトリガによりトリガが発生したときにデータが送信される。

const SubscriptionType RTM::OPS_TRIGGERRED_PERIODIC = 7
 

トリガ時に送信・一定周期で送信

OPS_TRIGGERRED_PERIODIC の送信条件がトリガに変わるだけで、そのほかの動作は OPS_TRIGGERRED_PERIODIC と同じになる。

const SubscriptionType RTM::OSP_PERIODIC_NEW = 4
 

一定周期でデータ更新時のみ送信

データ更新時のみ、予め設定された周期のタイミングでデータが送信される。 周期がΔt [s] に設定されたとき、データ送信のタイミングは、データが 更新されてから最も近い nΔt [s] に行われる。

const RtmRes RTM::RTM_ERR = 1
 

オペレーションはエラー終了した

const RtmRes RTM::RTM_FATAL_ERR = 4
 

オペレーションは致命的エラー終了した

const RtmRes RTM::RTM_OK = 0
 

オペレーションは正常終了した

const RtmRes RTM::RTM_WARNING = 2
 

オペレーションは警告終了した


OpenRTMに対してThu Dec 16 15:29:29 2004に生成されました。 doxygen 1.3.6