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

クラス RTObject_impl

すべてのメンバ一覧

Public メソッド

 __del__ ()
 onInitialize ()
 onFinalize ()
 onStartup (ec_id)
 onShutdown (ec_id)
 onActivated (ec_id)
 onDeactivated (ec_id)
 onExecute (ec_id)
 onAborting (ec_id)
 onError (ec_id)
 onReset (ec_id)
 onStateUpdate (ec_id)
 onRateChanged (ec_id)
 initialize ()
 finalize ()
 RTCを解体準備のため終了させる.
 exit ()
 RTCを停止させ、そのコンテンツと共に終了させる.
 is_alive ()
 get_contexts ()
 [CORBA interface] ExecutionContextListを取得する
 get_context (ec_id)
 [CORBA interface] ExecutionContextを取得する
 get_component_profile ()
 [RTObject CORBA interface] コンポーネントプロファイルの取得
 get_ports ()
 [RTObject CORBA interface] ポートの取得
 get_execution_context_services ()
 [RTObject CORBA interface] ExecutionContextAdmin の取得
 attach_executioncontext (exec_context)
 detach_executioncontext (ec_id)
 on_initialize ()
 on_finalize ()
 on_startup (ec_id)
 on_shutdown (ec_id)
 on_activated (ec_id)
 on_deactivated (ec_id)
 on_aborting (ec_id)
 on_error (ec_id)
 on_reset (ec_id)
 on_execute (ec_id)
 on_state_update (ec_id)
 on_rate_changed (ec_id)
 get_owned_organizations ()
 [CORBA interface] Organization リストの取得
 get_sdo_id ()
 [CORBA interface] SDO ID の取得
 get_sdo_type ()
 [CORBA interface] SDO タイプの取得
 get_device_profile ()
 [CORBA interface] SDO DeviceProfile リストの取得
 get_service_profiles ()
 [CORBA interface] SDO ServiceProfile の取得
 get_service_profile (_id)
 [CORBA interface] 特定のServiceProfileの取得
 get_sdo_service (_id)
 [CORBA interface] 指定された SDO Service の取得
 get_configuration ()
 [CORBA interface] Configuration オブジェクトの取得
 get_monitoring ()
 [CORBA interface] Monitoring オブジェクトの取得
 get_organizations ()
 [CORBA interface] Organization リストの取得
 get_status_list ()
 [CORBA interface] SDO Status リストの取得
 get_status (name)
 [CORBA interface] SDO Status の取得
 getInstanceName ()
 setInstanceName (instance_name)
 getTypeName ()
 getDescription ()
 getVersion ()
 getVendor ()
 getCategory ()
 getNamingNames ()
 setObjRef (rtobj)
 getObjRef ()
 setProperties (prop)
 [local interface] RTC のプロパティを設定する
 getProperties ()
 [local interface] RTC のプロパティを取得する
 bindParameter (param_name, var, def_val, trans=None)
 var はリストを渡す必要がある。
 updateParameters (config_set)
 registerPort (port)
 [local interface] Port を登録する
 registerInPort (name, inport)
 registerOutPort (name, outport)
 deletePort (port)
 [local interface] Port の登録を削除する
 deletePortByName (port_name)
 finalizePorts ()
 shutdown ()

構成

class  deactivate_comps
class  ec_copy
class  nv_name
class  svc_name
 SDOService のプロファイルリストからidでサーチするための ファンクタクラス. [詳細]

関数

RTObject_impl::__del__  ) 
 

RTObject_impl::attach_executioncontext exec_context   ) 
 

RTObject_impl::bindParameter param_name  ,
var  ,
def_val  ,
trans  = None
 

var はリストを渡す必要がある。

引数:
param_name name of Parameter.
var object.
def_val stirng of parameter.

RTObject_impl::deletePort port   ) 
 

[local interface] Port の登録を削除する

RTC が保持するPortの登録を削除する。

引数:
port RTC に登録する Port

RTObject_impl::deletePortByName port_name   ) 
 

RTObject_impl::detach_executioncontext ec_id   ) 
 

RTObject_impl::exit  ) 
 

RTCを停止させ、そのコンテンツと共に終了させる.

この RTC がオーナーであるすべての実行コンテキストが停止される。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければならない。

制約

  • RTC が初期化されていなければ、終了させることはできない。 Created 状態にある RTC に exit() を呼び出した場合、 ReturnCode_t::PRECONDITION_NOT_MET で失敗する。

RTObject_impl::finalize  ) 
 

RTCを解体準備のため終了させる.

このオペレーション呼び出しは結果としてComponentActionon_finalize() を呼び出す。

制約

  • この RTC が属する Running 状態の実行コンテキスト中、Active 状態にある ものがあればこの RTC は終了されない。その場合、このオペレーション呼び 出しはいかなる場合も ReturnCode_t::PRECONDITION_NOT_ME で失敗する。
  • この RTC が Created 状態である場合、終了処理は行われない。 その場合、このオペレーション呼び出しはいかなる場合も ReturnCode_t::PRECONDITION_NOT_MET で失敗する。
  • アプリケーション開発者はこのオペレーションを直接的に呼び出すことは まれであり、たいていはRTCインフラストラクチャから呼び出される。

RTObject_impl::finalizePorts  ) 
 

RTObject_impl::get_component_profile  ) 
 

[RTObject CORBA interface] コンポーネントプロファイルの取得

当該コンポーネントのプロファイル情報を返す。

RTObject_impl::get_configuration  ) 
 

[CORBA interface] Configuration オブジェクトの取得

このオペレーションは Configuration interface への参照を返す。 Configuration interface は各 SDO を管理するためのインターフェースの ひとつである。このインターフェースは DeviceProfile, ServiceProfile, Organization で定義された SDO の属性値を設定するために使用される。 Configuration インターフェースの詳細については、OMG SDO specification の 2.3.5節, p.2-24 を参照のこと。

戻り値:
SDO の Configuration インターフェースへの参照
例外:
InterfaceNotImplemented SDOはConfigurationインターフェースを 持たない。
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject_impl::get_context ec_id   ) 
 

[CORBA interface] ExecutionContextを取得する

RTObject_impl::get_contexts  ) 
 

[CORBA interface] ExecutionContextListを取得する

RTObject_impl::get_device_profile  ) 
 

[CORBA interface] SDO DeviceProfile リストの取得

SDO の DeviceProfile を返すオペレーション。 SDO がハードウエアデバイス に関連付けられていない場合には、空の DeviceProfile が返される。 このオペレーションは以下の型の例外を発生させる。

例外:
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。
戻り値:
SDO DeviceProfile

RTObject_impl::get_execution_context_services  ) 
 

[RTObject CORBA interface] ExecutionContextAdmin の取得

このオペレーションは当該 が所属する ExecutionContextに関連した ExecutionContextAdmin のリストを返す。

RTObject_impl::get_monitoring  ) 
 

[CORBA interface] Monitoring オブジェクトの取得

このオペレーションは Monitoring interface への参照を返す。 Monitoring interface は SDO が管理するインターフェースの一つである。 このインターフェースは SDO のプロパティをモニタリングするために 使用される。 Monitoring interface の詳細については OMG SDO specification の 2.3.7節 "Monitoring Interface" p.2-35 を参照のこと。

戻り値:
SDO の Monitoring interface への参照
例外:
InterfaceNotImplemented SDOはConfigurationインターフェースを 持たない。
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject_impl::get_organizations  ) 
 

[CORBA interface] Organization リストの取得

SDO は0個以上の Organization (組織)に所属することができる。 もし SDO が 1個以上の Organization に所属している場合、このオペレーションは所属する Organization のリストを返す。SDO が どの Organization にも所属していない 場合には、空のリストが返される。

戻り値:
SDO が所属する Organization のリスト。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject_impl::get_owned_organizations  ) 
 

[CORBA interface] Organization リストの取得

SDOSystemElement は0個もしくはそれ以上の Organization を所有することが 出来る。 SDOSystemElement が1つ以上の Organization を所有している場合 には、このオペレーションは所有する Organization のリストを返す。 もしOrganizationを一つも所有していないければ空のリストを返す。

RTObject_impl::get_ports  ) 
 

[RTObject CORBA interface] ポートの取得

当該コンポーネントが保有するポートの参照を返す。

RTObject_impl::get_sdo_id  ) 
 

[CORBA interface] SDO ID の取得

SDO ID を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。

例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。
戻り値:
リソースデータモデルで定義されている SDO の ID

RTObject_impl::get_sdo_service _id   ) 
 

[CORBA interface] 指定された SDO Service の取得

このオペレーションは引数 "id" で指定された名前によって区別される SDO の Service へのオブジェクト参照を返す。 SDO により提供される Service はそれぞれ一意の識別子により区別される。

引数:
id SDO Service に関連付けられた識別子。
戻り値:
要求された SDO Service への参照。

RTObject_impl::get_sdo_type  ) 
 

[CORBA interface] SDO タイプの取得

SDO Type を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。

例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。
戻り値:
リソースデータモデルで定義されている SDO の Type

RTObject_impl::get_service_profile _id   ) 
 

[CORBA interface] 特定のServiceProfileの取得

引数 "id" で指定された名前のサービスの ServiceProfile を返す。

引数:
id SDO Service の ServiceProfile に関連付けられた識別子。
戻り値:
指定された SDO Service の ServiceProfile。
例外:
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject_impl::get_service_profiles  ) 
 

[CORBA interface] SDO ServiceProfile の取得

SDO が所有している Service の ServiceProfile を返すオペレーション。 SDO がサービスを一つも所有していない場合には、空のリストを返す。 このオペレーションは以下の型の例外を発生させる。

例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。
戻り値:
SDO が提供する全ての Service の ServiceProfile。

RTObject_impl::get_status name   ) 
 

[CORBA interface] SDO Status の取得

This operation returns the value of the specified status parameter.

引数:
name SDO のステータスを定義するパラメータ。
戻り値:
指定されたパラメータのステータス値。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InvalidParameter 引数 "name" が null あるいは存在しない。
InternalError 内部的エラーが発生した。

RTObject_impl::get_status_list  ) 
 

[CORBA interface] SDO Status リストの取得

このオペレーションは SDO のステータスを表す NVList を返す。

戻り値:
SDO のステータス。
例外:
SDONotExists ターゲットのSDOが存在しない。
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

RTObject_impl::getCategory  ) 
 

RTObject_impl::getDescription  ) 
 

RTObject_impl::getInstanceName  ) 
 

RTObject_impl::getNamingNames  ) 
 

RTObject_impl::getObjRef  ) 
 

RTObject_impl::getProperties  ) 
 

[local interface] RTC のプロパティを取得する

RTC が保持しているプロパティを返す。 RTCがプロパティを持たない場合は空のプロパティが返される。

戻り値:
RTC のプロパティ

RTObject_impl::getTypeName  ) 
 

RTObject_impl::getVendor  ) 
 

RTObject_impl::getVersion  ) 
 

RTObject_impl::initialize  ) 
 

RTCを初期化する

このオペレーション呼び出しの結果として、ComponentActionon_initialize コールバック関数が呼ばれる。 制約 Created状態にいるときにのみ、初期化が行われる。他の状態にいる場合には ReturnCode_t::PRECONDITION_NOT_MET が返され呼び出しは失敗する。 このオペレーションはRTCのミドルウエアから呼ばれることを想定しており、 アプリケーション開発者は直接このオペレーションを呼ぶことは想定 されていない。

RTObject_impl::is_alive  ) 
 

RTObject_impl::on_aborting ec_id   ) 
 

RTObject_impl::on_activated ec_id   ) 
 

RTObject_impl::on_deactivated ec_id   ) 
 

RTObject_impl::on_error ec_id   ) 
 

RTObject_impl::on_execute ec_id   ) 
 

RTObject_impl::on_finalize  ) 
 

RTObject_impl::on_initialize  ) 
 

RTObject_impl::on_rate_changed ec_id   ) 
 

RTObject_impl::on_reset ec_id   ) 
 

RTObject_impl::on_shutdown ec_id   ) 
 

RTObject_impl::on_startup ec_id   ) 
 

RTObject_impl::on_state_update ec_id   ) 
 

RTObject_impl::onAborting ec_id   ) 
 

The aborting action when main logic error occurred. former rtc_aborting_entry()

RTObject_impl::onActivated ec_id   ) 
 

The activated action (Active state entry action) former rtc_active_entry()

RTObject_impl::onDeactivated ec_id   ) 
 

The deactivated action (Active state exit action) former rtc_active_exit()

RTObject_impl::onError ec_id   ) 
 

The error action in ERROR state former rtc_error_do()

RTObject_impl::onExecute ec_id   ) 
 

The execution action that is invoked periodically former rtc_active_do()

RTObject_impl::onFinalize  ) 
 

The finalize action (on ALIVE->END transition) formaer rtc_exiting_entry()

RTObject_impl::onInitialize  ) 
 

The initialize action (on CREATED->ALIVE transition) formaer rtc_init_entry()

RTObject_impl::onRateChanged ec_id   ) 
 

The action that is invoked when execution context's rate is changed no corresponding operation exists in OpenRTm-aist-0.2.0

RTObject_impl::onReset ec_id   ) 
 

The reset action that is invoked resetting This is same but different the former rtc_init_entry()

RTObject_impl::onShutdown ec_id   ) 
 

The shutdown action when ExecutionContext stop former rtc_stopping_entry()

RTObject_impl::onStartup ec_id   ) 
 

The startup action when ExecutionContext startup former rtc_starting_entry()

RTObject_impl::onStateUpdate ec_id   ) 
 

The state update action that is invoked after onExecute() action no corresponding operation exists in OpenRTm-aist-0.2.0

RTObject_impl::registerInPort name  ,
inport 
 

RTObject_impl::registerOutPort name  ,
outport 
 

RTObject_impl::registerPort port   ) 
 

[local interface] Port を登録する

RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。

引数:
port RTC に登録する Port

RTObject_impl::setInstanceName instance_name   ) 
 

RTObject_impl::setObjRef rtobj   ) 
 

RTObject_impl::setProperties prop   ) 
 

[local interface] RTC のプロパティを設定する

RTC が保持すべきプロパティを設定する。与えられるプロパティは、 ComponentProfile 等に設定されるべき情報を持たなければならない。 このオペレーションは通常 RTC が初期化される際に Manager から 呼ばれることを意図している。

引数:
prop RTC のプロパティ

RTObject_impl::shutdown  ) 
 

RTObject_impl::updateParameters config_set   ) 
 


このクラスの説明は次のファイルから生成されました:
OpenRTMに対してMon Oct 29 15:51:38 2007に生成されました。  doxygen 1.4.3