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

インタフェースRTM::RTComponent

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

import "RTComponent.idl";

RTM::RTComponentに対する継承グラフ

RTM::RTCBase すべてのメンバ一覧

Public 型

typedef short ComponentState
 コンポーネントのアクティビティ状態


Public メソッド

RtmRes rtc_start () raises (IllegalTransition)
 コンポーネントのアクティブ化

RtmRes rtc_stop () raises (IllegalTransition)
 コンポーネントの非アクティブ化

RtmRes rtc_reset () raises (IllegalTransition)
 コンポーネントのリセット

RtmRes rtc_exit () raises (IllegalTransition)
 コンポーネントのリセット

RtmRes rtc_kill ()
 コンポーネントの強制終了

RtmRes rtc_worker ()
 メインアクティビティのメソッド

InPort get_inport (in string name) raises (NoSuchName)
 InPort の取得.

OutPort get_outport (in string name) raises (NoSuchName)
 OutPort の取得.


Public 変数

readonly attribute string instance_id
 コンポーネントのインスタンスID

readonly attribute string implementation_id
 コンポーネントのインプリメンテーションID

readonly attribute string description
 コンポーネントの概要

readonly attribute string version
 コンポーネントのバージョン

readonly attribute string maker
 コンポーネントの作成者

readonly attribute string category
 コンポーネントのカテゴリ

const ComponentState RTC_UNKNOWN = 0
 UNKNOWN state.

const ComponentState RTC_BORN = 1
 BORN state.

const ComponentState RTC_INITIALIZING = 2
 INITIALIZING state.

const ComponentState RTC_READY = 3
 READY state.

const ComponentState RTC_STARTING = 4
 STARTING state.

const ComponentState RTC_ACTIVE = 5
 ACTIVE state.

const ComponentState RTC_STOPPING = 6
 STOPPING state.

const ComponentState RTC_ABORTING = 7
 ABORTING state.

const ComponentState RTC_ERROR = 8
 ERROR state.

const ComponentState RTC_FATAL_ERROR = 9
 FATAL_ERROR state.

const ComponentState RTC_EXITING = 10
 EXITING state.

readonly attribute OutPort rtc_state
 アクティビティステータスのOutPortの取得

readonly attribute InPortList inports
 InPortList の取得.

readonly attribute OutPortList outports
 OutPortList の取得.


説明

RTComponent インターフェース.


型定義

typedef short RTM::RTComponent::ComponentState
 

コンポーネントのアクティビティ状態


関数

InPort RTM::RTComponent::get_inport in string  name  )  raises (NoSuchName)
 

InPort の取得.

InPort のオブジェクトリファレンスを取得する。

引数:
name InPort

OutPort RTM::RTComponent::get_outport in string  name  )  raises (NoSuchName)
 

OutPort の取得.

OutPort のオブジェクトリファレンスを取得する。

引数:
name OutPort

RtmRes RTM::RTComponent::rtc_exit  )  raises (IllegalTransition)
 

コンポーネントのリセット

コンポーネントの状態を EXITING に遷移させる。 EXITING 状態に遷移したコンポーネントは二度と復帰することなく終了する。

RtmRes RTM::RTComponent::rtc_kill  ) 
 

コンポーネントの強制終了

FATAL_ERROR 状態のコンポーネントを EXITING に遷移させる。 EXITING 状態に遷移したコンポーネントは二度と復帰することなく終了する。

RtmRes RTM::RTComponent::rtc_reset  )  raises (IllegalTransition)
 

コンポーネントのリセット

コンポーネントの状態を ERROR から INITIALIZE に遷移させる。 INITIALIZE 後エラーがなければすぐに READY 状態に遷移する。 このオペレーションを発行するとき、コンポーネントは ERROR 状態でなければ ならない。他の状態の場合には IllegalTransition 例外が発生する。

RtmRes RTM::RTComponent::rtc_start  )  raises (IllegalTransition)
 

コンポーネントのアクティブ化

コンポーネントの状態を READY から ACTIVE に遷移させる。 このオペレーションを発行するとき、コンポーネントは READY 状態でなければ ならない。他の状態の場合には IllegalTransition 例外が発生する。

RtmRes RTM::RTComponent::rtc_stop  )  raises (IllegalTransition)
 

コンポーネントの非アクティブ化

コンポーネントの状態を ACTIVE から READY に遷移させる。 このオペレーションを発行するとき、コンポーネントは ACTIVE 状態でなければ ならない。他の状態の場合には IllegalTransition 例外が発生する。

RtmRes RTM::RTComponent::rtc_worker  ) 
 

メインアクティビティのメソッド

コンポーネントのアクティビティの本体はこのメソッドを周期実行することに より処理される。単体のコンポーネントでは内部的なスレッドによりこのメソ ッドを周期呼出することで処理を行っている。 スレッドを停止させ、外部からこのオペレーションを呼び出すことにより、任 意のタイミングでアクティビティを実行することも出来る。


変数

readonly attribute string RTM::RTComponent::category
 

コンポーネントのカテゴリ

readonly attribute string RTM::RTComponent::description
 

コンポーネントの概要

readonly attribute string RTM::RTComponent::implementation_id
 

コンポーネントのインプリメンテーションID

readonly attribute InPortList RTM::RTComponent::inports
 

InPortList の取得.

InPort のオブジェクトリファレンスのリストを取得する。

readonly attribute string RTM::RTComponent::instance_id
 

コンポーネントのインスタンスID

readonly attribute string RTM::RTComponent::maker
 

コンポーネントの作成者

readonly attribute OutPortList RTM::RTComponent::outports
 

OutPortList の取得.

OutPort のオブジェクトリファレンスのリストを取得する。

const ComponentState RTM::RTComponent::RTC_ABORTING = 7
 

ABORTING state.

const ComponentState RTM::RTComponent::RTC_ACTIVE = 5
 

ACTIVE state.

const ComponentState RTM::RTComponent::RTC_BORN = 1
 

BORN state.

const ComponentState RTM::RTComponent::RTC_ERROR = 8
 

ERROR state.

const ComponentState RTM::RTComponent::RTC_EXITING = 10
 

EXITING state.

const ComponentState RTM::RTComponent::RTC_FATAL_ERROR = 9
 

FATAL_ERROR state.

const ComponentState RTM::RTComponent::RTC_INITIALIZING = 2
 

INITIALIZING state.

const ComponentState RTM::RTComponent::RTC_READY = 3
 

READY state.

const ComponentState RTM::RTComponent::RTC_STARTING = 4
 

STARTING state.

readonly attribute OutPort RTM::RTComponent::rtc_state
 

アクティビティステータスのOutPortの取得

アクティビティステータスのOutPortのオブジェクトリファレンスを取得する。

const ComponentState RTM::RTComponent::RTC_STOPPING = 6
 

STOPPING state.

const ComponentState RTM::RTComponent::RTC_UNKNOWN = 0
 

UNKNOWN state.

readonly attribute string RTM::RTComponent::version
 

コンポーネントのバージョン


このインタフェースの説明は次のファイルから生成されました:
OpenRTMに対してThu Dec 16 15:29:30 2004に生成されました。 doxygen 1.3.6