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

インタフェースRTM::RTCBase

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

import "RTCBase.idl";

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

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

Public 型

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


Public メソッド

RtmRes rtc_ready_entry ()
 entry: ready() メソッド

RtmRes rtc_ready_do ()
 do: ready() メソッド.

RtmRes rtc_ready_exit ()
 exit: ready() メソッド.

RtmRes rtc_active_entry ()
 entry: active() メソッド.

RtmRes rtc_active_do ()
 do: active() メソッド.

RtmRes rtc_active_exit ()
 exit: active() メソッド.

RtmRes rtc_error_entry ()
 entry: error() メソッド

RtmRes rtc_error_do ()
 do: error() メソッド.

RtmRes rtc_error_exit ()
 exit: error() メソッド.

RtmRes rtc_fatal_entry ()
 entry: fatal() メソッド

RtmRes rtc_fatal_do ()
 do: fatal() メソッド.

RtmRes rtc_fatal_exit ()
 exit: fatal() メソッド.

RtmRes rtc_init_entry ()
 entry: init() メソッド

RtmRes rtc_starting_entry ()
 entry: starting() メソッド

RtmRes rtc_stopping_entry ()
 entry: stopping() メソッド

RtmRes rtc_aborting_entry ()
 entry: aborting() メソッド

RtmRes rtc_exiting_entry ()
 entry: exiting() メソッド

RtmRes rtc_stop_thread ()
 アクティビティスレッドのスタート

RtmRes rtc_start_thread ()
 アクティビティスレッドのストップ

RtmRes rtc_set_parent (in RTCBase comp)
 親コンポーネントをセットする

RtmRes rtc_add_component (in RTCBase comp)
 子コンポーネントを追加する

RtmRes rtc_delete_component (in RTCBase comp)
 子コンポーネントを削除する

RtmRes rtc_replace_component (in RTCBase comp1, in RTCBase comp2)
 子コンポーネントの順序を入れ替える

RtmRes rtc_replace_component_by_name (in string name1, in string name2)
 子コンポーネントの順序を入れ替える

RTCBaseList rtc_components ()
 子コンポーネントをリストとして取得する。

RTCBase rtc_get_component (in string name)
 子コンポーネントを名前を指定して取得

RtmRes rtc_attach_inport (in InPort in_port)
 InPortをアタッチする.

RtmRes rtc_attach_inport_by_name (in RTCBase comp, in string name)
 InPortをアタッチする.

RtmRes rtc_detatch_inport (in InPort in_port)
 InPortをデタッチする.

RtmRes rtc_detatch_inport_by_name (in string name)
 InPortをデタッチする.

RtmRes rtc_attach_outport (in OutPort out_port)
 OutPortをアタッチする.

RtmRes rtc_attach_outport_by_name (in RTCBase comp, in string name)
 OutPortをアタッチする.

RtmRes rtc_detatch_outport (in OutPort out_port)
 OutPortをデタッチする.

RtmRes rtc_detatch_outport_by_name (in string name)
 OutPortをデタッチする.

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 RTCProfile profile
 コンポーネントのプロファイル構造体

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 の取得.


説明

RTCBase インターフェース.

RTComponent インターフェースを継承し、主に複合コンポーネント化に必要な メソッドを追加したインターフェース。 コンポーネントアクティビティ状態に対応するメソッド、アクティビティスレッド の制御、子コンポーネントの追加、削除、置換を行うオペレーションが追加され ている.


型定義

typedef short RTM::RTComponent::ComponentState [inherited]
 

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


関数

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

InPort の取得.

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

引数:
name InPort

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

OutPort の取得.

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

引数:
name OutPort

RtmRes RTM::RTCBase::rtc_aborting_entry  ) 
 

entry: aborting() メソッド

ABORTING 状態へ進入するときに1度だけ呼び出されるメソッド。 エラーがなければ READY 状態へ遷移する。 戻り値が RTM_ERR で ERROR 状態へ、 RTM_FATALERR で FATAL_ERROR 状態へ 遷移する。

RtmRes RTM::RTCBase::rtc_active_do  ) 
 

do: active() メソッド.

ACTIVE 状態に居る間周期実行されるメソッド。

RtmRes RTM::RTCBase::rtc_active_entry  ) 
 

entry: active() メソッド.

ACTIVE 状態に進入するときに1度だけ実行されるメソッド。

RtmRes RTM::RTCBase::rtc_active_exit  ) 
 

exit: active() メソッド.

ACTIVE 状態から出るときに1度だけ実行されるメソッド。

RtmRes RTM::RTCBase::rtc_add_component in RTCBase  comp  ) 
 

子コンポーネントを追加する

子コンポーネントのオブジェクトリファレンスをセットする。 単体コンポーネントにおいてこのメソッドは未使用のため、RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_attach_inport in InPort  in_port  ) 
 

InPortをアタッチする.

子コンポーネントのInPortをこのコンポーネントのInPortにアタッチする。 単体コンポーネントにおいては自分自身オブジェクトリファレンスを返す。

RtmRes RTM::RTCBase::rtc_attach_inport_by_name in RTCBase  comp,
in string  name
 

InPortをアタッチする.

子コンポーネントのInPort名を指定してコンポーネントのInPortにアタッチ する。 単体コンポーネントにおいては自分自身オブジェクトリファレンスを返す。

RtmRes RTM::RTCBase::rtc_attach_outport in OutPort  out_port  ) 
 

OutPortをアタッチする.

子コンポーネントのOutPortをこのコンポーネントのOutPortにアタッチする。 単体コンポーネントにおいては自分自身オブジェクトリファレンスを返す。

RtmRes RTM::RTCBase::rtc_attach_outport_by_name in RTCBase  comp,
in string  name
 

OutPortをアタッチする.

子コンポーネントのOutPort名を指定してコンポーネントのInPortにアタッチ する。 単体コンポーネントにおいては自分自身オブジェクトリファレンスを返す。

RTCBaseList RTM::RTCBase::rtc_components  ) 
 

子コンポーネントをリストとして取得する。

子コンポーネントのリストを取得する。 単体コンポーネントにおいては自分自身オブジェクトリファレンスを返す。

RtmRes RTM::RTCBase::rtc_delete_component in RTCBase  comp  ) 
 

子コンポーネントを削除する

子コンポーネントのオブジェクトリファレンスを削除する。 単体コンポーネントにおいてこのメソッドは未使用のため、RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_detatch_inport in InPort  in_port  ) 
 

InPortをデタッチする.

子コンポーネントのInPortをこのコンポーネントのInPortからデタッチする。 単体コンポーネントにおいては RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_detatch_inport_by_name in string  name  ) 
 

InPortをデタッチする.

子コンポーネントのInPortを名前を指定してこのコンポーネントのInPortから デタッチする。 単体コンポーネントにおいては RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_detatch_outport in OutPort  out_port  ) 
 

OutPortをデタッチする.

子コンポーネントのOutPortをこのコンポーネントのOutPortからデタッチする。 単体コンポーネントにおいては RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_detatch_outport_by_name in string  name  ) 
 

OutPortをデタッチする.

子コンポーネントのOutPortを名前を指定してこのコンポーネントのOutPortから デタッチする。 単体コンポーネントにおいては RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_error_do  ) 
 

do: error() メソッド.

ERROR 状態にいる間周期実行されるメソッド。

RtmRes RTM::RTCBase::rtc_error_entry  ) 
 

entry: error() メソッド

ERROR 状態へ進入するときに1度だけ呼び出されるメソッド。

RtmRes RTM::RTCBase::rtc_error_exit  ) 
 

exit: error() メソッド.

ERROR 状態から出るときに1度だけ実行されるメソッド。

RtmRes RTM::RTComponent::rtc_exit  )  raises (IllegalTransition) [inherited]
 

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

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

RtmRes RTM::RTCBase::rtc_exiting_entry  ) 
 

entry: exiting() メソッド

EXITING 状態へ進入するときに1度だけ呼び出されるメソッド。 エラーがなければ READY 状態へ遷移する。 戻り値が RTM_ERR で ERROR 状態へ、 RTM_FATALERR で FATAL_ERROR 状態へ 遷移する。

RtmRes RTM::RTCBase::rtc_fatal_do  ) 
 

do: fatal() メソッド.

FATAL_ERROR 状態にいる間周期実行されるメソッド。

RtmRes RTM::RTCBase::rtc_fatal_entry  ) 
 

entry: fatal() メソッド

FATAL_ERROR 状態へ進入するときに1度だけ呼び出されるメソッド。

RtmRes RTM::RTCBase::rtc_fatal_exit  ) 
 

exit: fatal() メソッド.

READY 状態から出るときに1度だけ実行されるメソッド。

RTCBase RTM::RTCBase::rtc_get_component in string  name  ) 
 

子コンポーネントを名前を指定して取得

子コンポーネントを名前を指定してそのオブジェクトリファレンスを取得する。 単体コンポーネントにおいては自分自身オブジェクトリファレンスを返す。

RtmRes RTM::RTCBase::rtc_init_entry  ) 
 

entry: init() メソッド

INITIALIZING 状態へ進入するときに1度だけ呼び出されるメソッド。 エラーがなければ READY 状態へ遷移する。 戻り値が RTM_ERR で ERROR 状態へ、 RTM_FATALERR で FATAL_ERROR 状態へ 遷移する。

RtmRes RTM::RTComponent::rtc_kill  )  [inherited]
 

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

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

RtmRes RTM::RTCBase::rtc_ready_do  ) 
 

do: ready() メソッド.

READY 状態にいる間周期実行されるメソッド。

RtmRes RTM::RTCBase::rtc_ready_entry  ) 
 

entry: ready() メソッド

READY 状態へ進入するときに1度だけ呼び出されるメソッド。

RtmRes RTM::RTCBase::rtc_ready_exit  ) 
 

exit: ready() メソッド.

READY 状態から出るときに1度だけ実行されるメソッド。

RtmRes RTM::RTCBase::rtc_replace_component in RTCBase  comp1,
in RTCBase  comp2
 

子コンポーネントの順序を入れ替える

2つの子コンポーネントをオブジェクトリファレンスを使用して順序を入れ替え る。 単体コンポーネントにおいてこのメソッドは未使用のため、RTM_ERR を返す。

RtmRes RTM::RTCBase::rtc_replace_component_by_name in string  name1,
in string  name2
 

子コンポーネントの順序を入れ替える

2つの子コンポーネントの順序をコンポーネント名を指定して入れ替える。 単体コンポーネントにおいてこのメソッドは未使用のため、RTM_ERR を返す。

RtmRes RTM::RTComponent::rtc_reset  )  raises (IllegalTransition) [inherited]
 

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

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

RtmRes RTM::RTCBase::rtc_set_parent in RTCBase  comp  ) 
 

親コンポーネントをセットする

親コンポーネントのオブジェクトリファレンスをセットする。

RtmRes RTM::RTComponent::rtc_start  )  raises (IllegalTransition) [inherited]
 

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

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

RtmRes RTM::RTCBase::rtc_start_thread  ) 
 

アクティビティスレッドのストップ

コンポーネントアクティビティの内部スレッドをストップさせる

RtmRes RTM::RTCBase::rtc_starting_entry  ) 
 

entry: starting() メソッド

STARTING 状態へ進入するときに1度だけ呼び出されるメソッド。 エラーがなければ ACTIVE 状態へ遷移する。 戻り値が RTM_ERR で ERROR 状態へ、 RTM_FATALERR で FATAL_ERROR 状態へ 遷移する。

RtmRes RTM::RTComponent::rtc_stop  )  raises (IllegalTransition) [inherited]
 

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

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

RtmRes RTM::RTCBase::rtc_stop_thread  ) 
 

アクティビティスレッドのスタート

コンポーネントアクティビティの内部スレッドをスタートさせる

RtmRes RTM::RTCBase::rtc_stopping_entry  ) 
 

entry: stopping() メソッド

STOPPING 状態へ進入するときに1度だけ呼び出されるメソッド。 エラーがなければ READY 状態へ遷移する。 戻り値が RTM_ERR で ERROR 状態へ、 RTM_FATALERR で FATAL_ERROR 状態へ 遷移する。

RtmRes RTM::RTComponent::rtc_worker  )  [inherited]
 

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

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


変数

readonly attribute string RTM::RTComponent::category [inherited]
 

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

readonly attribute string RTM::RTComponent::description [inherited]
 

コンポーネントの概要

readonly attribute string RTM::RTComponent::implementation_id [inherited]
 

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

readonly attribute InPortList RTM::RTComponent::inports [inherited]
 

InPortList の取得.

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

readonly attribute string RTM::RTComponent::instance_id [inherited]
 

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

readonly attribute string RTM::RTComponent::maker [inherited]
 

コンポーネントの作成者

readonly attribute OutPortList RTM::RTComponent::outports [inherited]
 

OutPortList の取得.

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

readonly attribute RTCProfile RTM::RTCBase::profile
 

コンポーネントのプロファイル構造体

const ComponentState RTM::RTComponent::RTC_ABORTING = 7 [inherited]
 

ABORTING state.

const ComponentState RTM::RTComponent::RTC_ACTIVE = 5 [inherited]
 

ACTIVE state.

const ComponentState RTM::RTComponent::RTC_BORN = 1 [inherited]
 

BORN state.

const ComponentState RTM::RTComponent::RTC_ERROR = 8 [inherited]
 

ERROR state.

const ComponentState RTM::RTComponent::RTC_EXITING = 10 [inherited]
 

EXITING state.

const ComponentState RTM::RTComponent::RTC_FATAL_ERROR = 9 [inherited]
 

FATAL_ERROR state.

const ComponentState RTM::RTComponent::RTC_INITIALIZING = 2 [inherited]
 

INITIALIZING state.

const ComponentState RTM::RTComponent::RTC_READY = 3 [inherited]
 

READY state.

const ComponentState RTM::RTComponent::RTC_STARTING = 4 [inherited]
 

STARTING state.

readonly attribute OutPort RTM::RTComponent::rtc_state [inherited]
 

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

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

const ComponentState RTM::RTComponent::RTC_STOPPING = 6 [inherited]
 

STOPPING state.

const ComponentState RTM::RTComponent::RTC_UNKNOWN = 0 [inherited]
 

UNKNOWN state.

readonly attribute string RTM::RTComponent::version [inherited]
 

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


このインタフェースの説明は次のファイルから生成されました:
OpenRTMに対してMon May 23 03:14:09 2005に生成されました。 doxygen 1.3.6