クラス RTC::RTObject_impl

RTコンポーネントクラス [詳細]

#include <RTObject.h>

RTC::RTObject_implに対する継承グラフ

RTC::DataFlowComponentBase

すべてのメンバ一覧

Public メソッド

 RTObject_impl (Manager *manager)
 コンストラクタ
 RTObject_impl (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
 コンストラクタ
virtual ~RTObject_impl ()
 仮想デストラクタ
virtual ReturnCode_t initialize () throw (CORBA::SystemException)
 [CORBA interface] RTCを初期化する
virtual ReturnCode_t finalize () throw (CORBA::SystemException)
 [CORBA interface] RTC を終了する
virtual ReturnCode_t exit () throw (CORBA::SystemException)
 [CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる
virtual CORBA::Boolean is_alive () throw (CORBA::SystemException)
 [CORBA interface] RTC が Alive 状態であるかどうか確認する。
virtual
ExecutionContextList * 
get_contexts () throw (CORBA::SystemException)
 [CORBA interface] ExecutionContextListを取得する
virtual
ExecutionContext_ptr 
get_context (UniqueId ec_id) throw (CORBA::SystemException)
 [CORBA interface] ExecutionContextを取得する
UniqueId attach_executioncontext (ExecutionContext_ptr exec_context) throw (CORBA::SystemException)
 [CORBA interface] ExecutionContextをattachする
ReturnCode_t detach_executioncontext (UniqueId ec_id) throw (CORBA::SystemException)
 [CORBA interface] ExecutionContextをdetachする
virtual
ComponentProfile * 
get_component_profile () throw (CORBA::SystemException)
 [RTObject CORBA interface] コンポーネントプロファイルを取得する
virtual PortList * get_ports () throw (CORBA::SystemException)
 [RTObject CORBA interface] ポートを取得する
virtual
ExecutionContextServiceList * 
get_execution_context_services () throw (CORBA::SystemException)
 [RTObject CORBA interface] ExecutionContextAdmin を取得する
virtual ReturnCode_t on_initialize () throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC の初期化
virtual ReturnCode_t on_finalize () throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC の終了
virtual ReturnCode_t on_startup (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC の開始
virtual ReturnCode_t on_shutdown (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC の停止
virtual ReturnCode_t on_activated (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC の活性化
virtual ReturnCode_t on_deactivated (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC の非活性化
virtual ReturnCode_t on_aborting (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC のエラー状態への遷移
virtual ReturnCode_t on_error (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC のエラー処理
virtual ReturnCode_t on_reset (UniqueId ec_id) throw (CORBA::SystemException)
 [ComponentAction CORBA interface] RTC のリセット
virtual ReturnCode_t on_execute (UniqueId ec_id) throw (CORBA::SystemException)
 [DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)
virtual ReturnCode_t on_state_update (UniqueId ec_id) throw (CORBA::SystemException)
 [DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)
virtual ReturnCode_t on_rate_changed (UniqueId ec_id) throw (CORBA::SystemException)
 [DataFlowComponentAction CORBA interface] 実行周期変更通知
virtual
SDOPackage::OrganizationList * 
get_owned_organizations () throw (CORBA::SystemException, SDOPackage::NotAvailable)
 [SDO interface] Organization リストの取得
virtual char * get_sdo_id () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] SDO ID の取得
virtual char * get_sdo_type () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] SDO タイプの取得
virtual
SDOPackage::DeviceProfile * 
get_device_profile () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] SDO DeviceProfile リストの取得
virtual
SDOPackage::ServiceProfileList * 
get_service_profiles () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] SDO ServiceProfile の取得
virtual
SDOPackage::ServiceProfile * 
get_service_profile (const char *id) throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] 特定のServiceProfileの取得
virtual
SDOPackage::SDOService_ptr 
get_sdo_service (const char *id) throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] 指定された SDO Service の取得
virtual
SDOPackage::Configuration_ptr 
get_configuration () throw (CORBA::SystemException, SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Configuration オブジェクトの取得
virtual
SDOPackage::Monitoring_ptr 
get_monitoring () throw (CORBA::SystemException, SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Monitoring オブジェクトの取得
virtual
SDOPackage::OrganizationList * 
get_organizations () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] Organization リストの取得
virtual
SDOPackage::NVList * 
get_status_list () throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] SDO Status リストの取得
virtual CORBA::Any * get_status (const char *name) throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError)
 [SDO interface] SDO Status の取得
const char * getInstanceName ()
 [local interface] インスタンス名の取得
void setInstanceName (const char *instance_name)
 [local interface] インスタンス名の設定
const char * getTypeName ()
 [local interface] 型名の取得
const char * getDescription ()
 [local interface] Description の取得
const char * getVersion ()
 [local interface] バージョン情報の取得
const char * getVendor ()
 [local interface] ベンダー情報の取得
const char * getCategory ()
 [local interface] カテゴリ情報の取得
std::vector
< std::string > 
getNamingNames ()
 [local interface] Naming Server 情報の取得
void setObjRef (const RTObject_ptr rtobj)
 [local interface] オブジェクトリファレンスの設定
RTObject_ptr getObjRef () const
 [local interface] オブジェクトリファレンスの取得
void setProperties (const Properties &prop)
 [local interface] RTC のプロパティを設定する
PropertiesgetProperties ()
 [local interface] RTC のプロパティを取得する
template<typename VarType>
bool bindParameter (const char *param_name, VarType &var, const char *def_val, bool(*trans)(VarType &, const char *)=::stringTo)
 コンフィギュレーションパラメータの設定
void updateParameters (const char *config_set)
 コンフィギュレーションパラメータの更新(ID指定)
void registerPort (PortBase &port)
 [local interface] Port を登録する
template<class DataType, template< class DataType > class Buffer>
void registerInPort (const char *name, InPort< DataType, Buffer > &inport)
 [local interface] DataInPort を登録する
template<class DataType, template< class DataType > class Buffer>
void registerOutPort (const char *name, OutPort< DataType, Buffer > &outport)
 [local interface] DataOutPort を登録する
void deletePort (PortBase &port)
 [local interface] Port の登録を削除する
void deletePortByName (const char *port_name)
 [local interface] 名前指定により Port の登録を削除する
void finalizePorts ()
 全 Port の登録を削除する

Protected メソッド

virtual ReturnCode_t onInitialize ()
 初期化処理用コールバック関数
virtual ReturnCode_t onFinalize ()
 終了処理用コールバック関数
virtual ReturnCode_t onStartup (RTC::UniqueId ec_id)
 開始処理用コールバック関数
virtual ReturnCode_t onShutdown (RTC::UniqueId ec_id)
 停止処理用コールバック関数
virtual ReturnCode_t onActivated (RTC::UniqueId ec_id)
 活性化処理用コールバック関数
virtual ReturnCode_t onDeactivated (RTC::UniqueId ec_id)
 非活性化処理用コールバック関数
virtual ReturnCode_t onExecute (RTC::UniqueId ec_id)
 周期処理用コールバック関数
virtual ReturnCode_t onAborting (RTC::UniqueId ec_id)
 中断処理用コールバック関数
virtual ReturnCode_t onError (RTC::UniqueId ec_id)
 エラー処理用コールバック関数
virtual ReturnCode_t onReset (RTC::UniqueId ec_id)
 リセット処理用コールバック関数
virtual ReturnCode_t onStateUpdate (RTC::UniqueId ec_id)
 状態変更処理用コールバック関数
virtual ReturnCode_t onRateChanged (RTC::UniqueId ec_id)
 動作周期変更通知用コールバック関数
void shutdown ()
 RTC を終了する

Protected 変数

Managerm_pManager
 マネージャオブジェクト
CORBA::ORB_var m_pORB
 ORB へのポインタ
PortableServer::POA_var m_pPOA
 POA へのポインタ
SDOPackage::OrganizationList m_sdoOwnedOrganizations
 SDO が保持する organization のリスト
SDOPackage::ServiceProfileList m_sdoSvcProfiles
 SDOService のプロファイルリスト
SDOPackage::Configuration_implm_pSdoConfigImpl
 SDO Configuration オブジェクトへのポインタ
SDOPackage::Configuration_var m_pSdoConfig
 SDO Configuration Interface へのポインタ
SDOPackage::OrganizationList m_sdoOrganizations
 SDO organization
SDOPackage::NVList m_sdoStatus
 SDO Status
ComponentProfile m_profile
 コンポーネントプロファイル
RTObject_ptr m_objref
 オブジェクトリファレンス
PortAdmin m_portAdmin
 Port のオブジェクトリファレンスのリスト
ExecutionContextServiceList m_execContexts
 ExecutionContextService のリスト
bool m_created
 Created 状態フラグ
bool m_alive
 Alive 状態フラグ
Properties m_properties
 RTC のプロパティ
ConfigAdmin m_configsets
 コンフィギュレーション情報管理オブジェクト

構成

struct  deactivate_comps
 RTC 非活性化用ファンクタ [詳細]
struct  ec_copy
 ExecutionContext 検索用ファンクタ [詳細]
struct  nv_name
 NVList 検索用ファンクタ [詳細]
struct  svc_name
 SDOService のプロファイルリストからidでサーチするためのファンクタ [詳細]


説明

RTコンポーネントクラス

各RTコンポーネントのベースとなるクラス。 Robotic Technology Component 仕様中の lightweightRTComponentの実装クラス。 コンポーネントの機能を提供する ComponentAction インターフェースと コンポーネントのライフサイクル管理を行うための LightweightRTObject の実装を 提供する。 実際にユーザがコンポーネントを作成する場合には、Execution Semantics に対応 した各サブクラスを利用する。
(現状の実装では Periodic Sampled Data Processing のみサポートしているため、 dataFlowComponent を直接継承している)

から:
0.2.0

コンストラクタとデストラクタ

RTC::RTObject_impl::RTObject_impl ( Manager manager  ) 

コンストラクタ

コンストラクタ

引数:
manager マネージャオブジェクト

RTC::RTObject_impl::RTObject_impl ( CORBA::ORB_ptr  orb,
PortableServer::POA_ptr  poa 
)

コンストラクタ

コンストラクタ

引数:
orb ORB
poa POA

virtual RTC::RTObject_impl::~RTObject_impl (  )  [virtual]

仮想デストラクタ


関数

virtual ReturnCode_t RTC::RTObject_impl::onInitialize (  )  [protected, virtual]

初期化処理用コールバック関数

ComponentAction::on_initialize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の初期化処理は、本関数をオーバーライドして実装する 必要がある。

戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onFinalize (  )  [protected, virtual]

終了処理用コールバック関数

ComponentAction::on_finalize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の終了処理は、本関数をオーバーライドして実装する 必要がある。

戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onStartup ( RTC::UniqueId  ec_id  )  [protected, virtual]

開始処理用コールバック関数

ComponentAction::on_startup が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の開始処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onShutdown ( RTC::UniqueId  ec_id  )  [protected, virtual]

停止処理用コールバック関数

ComponentAction::on_shutdown が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の停止処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onActivated ( RTC::UniqueId  ec_id  )  [protected, virtual]

活性化処理用コールバック関数

ComponentAction::on_activated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の活性化処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onDeactivated ( RTC::UniqueId  ec_id  )  [protected, virtual]

非活性化処理用コールバック関数

ComponentAction::on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の非活性化処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onExecute ( RTC::UniqueId  ec_id  )  [protected, virtual]

周期処理用コールバック関数

DataFlowComponentAction::on_execute が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の周期処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 1回目の実行パスとして定期的に呼び出される。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onAborting ( RTC::UniqueId  ec_id  )  [protected, virtual]

中断処理用コールバック関数

ComponentAction::on_aborting が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の中断処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onError ( RTC::UniqueId  ec_id  )  [protected, virtual]

エラー処理用コールバック関数

ComponentAction::on_error が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のエラー処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onReset ( RTC::UniqueId  ec_id  )  [protected, virtual]

リセット処理用コールバック関数

ComponentAction::on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドして実装する 必要がある。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onStateUpdate ( RTC::UniqueId  ec_id  )  [protected, virtual]

状態変更処理用コールバック関数

DataFlowComponentAction::on_state_update が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 2回目の実行パスとして定期的に呼び出される。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::onRateChanged ( RTC::UniqueId  ec_id  )  [protected, virtual]

動作周期変更通知用コールバック関数

DataFlowComponentAction::on_rate_changed が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing において ExecutionContext の 実行が更新された際に呼び出される。

引数:
ec_id 参加している ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::initialize (  )  throw (CORBA::SystemException) [virtual]

[CORBA interface] RTCを初期化する

このオペレーション呼び出しの結果として、ComponentActionon_initialize コールバック関数が呼ばれる。

制約

戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::finalize (  )  throw (CORBA::SystemException) [virtual]

[CORBA interface] RTC を終了する

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

制約

戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::exit (  )  throw (CORBA::SystemException) [virtual]

[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる

この RTC がオーナーであるすべての実行コンテキストを停止する。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければならない。 RTC が実行中のどの ExecutionContext でも Active 状態ではなくなった後、 この RTC とこれに含まれる RTC が終了する。

制約

戻り値:
ReturnCode_t 型のリターンコード

virtual CORBA::Boolean RTC::RTObject_impl::is_alive (  )  throw (CORBA::SystemException) [virtual]

[CORBA interface] RTC が Alive 状態であるかどうか確認する。

RTC が指定した ExecutionContext に対して Alive状態であるかどうか確認する。 RTC の状態が Active であるか、Inactive であるか、Error であるかは実行中の ExecutionContext に依存する。すなわち、ある ExecutionContext に対しては Active 状態であっても、他の ExecutionContext に対しては Inactive 状態と なる場合もありえる。従って、このオペレーションは指定された ExecutionContext に問い合わせて、この RTC の状態が Active、Inactive、 Error の場合には Alive 状態として返す。

戻り値:
Alive 状態確認結果

virtual ExecutionContextList* RTC::RTObject_impl::get_contexts (  )  throw (CORBA::SystemException) [virtual]

[CORBA interface] ExecutionContextListを取得する

この RTC が所有する ExecutionContext のリストを取得する。

戻り値:
ExecutionContext リスト

virtual ExecutionContext_ptr RTC::RTObject_impl::get_context ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[CORBA interface] ExecutionContextを取得する

指定したハンドルの ExecutionContext を取得する。 ハンドルから ExecutionContext へのマッピングは、特定の RTC インスタンスに 固有である。ハンドルはこの RTC を attach_context した際に取得できる。

引数:
ec_id 取得対象 ExecutionContext ハンドル
戻り値:
ExecutionContext

UniqueId RTC::RTObject_impl::attach_executioncontext ( ExecutionContext_ptr  exec_context  )  throw (CORBA::SystemException)

[CORBA interface] ExecutionContextをattachする

指定した ExecutionContext にこの RTC を所属させる。この RTC と関連する ExecutionContext のハンドルを返す。 このオペレーションは、ExecutionContextOperationsadd_component が呼ばれた 際に呼び出される。返されたハンドルは他のクライアントで使用することを想定 していない。

引数:
exec_context 所属先 ExecutionContext
戻り値:
ExecutionContext ハンドル

ReturnCode_t RTC::RTObject_impl::detach_executioncontext ( UniqueId  ec_id  )  throw (CORBA::SystemException)

[CORBA interface] ExecutionContextをdetachする

指定した ExecutionContext からこの RTC の所属を解除する。 このオペレーションは、ExecutionContextOperationsremove_component が呼ば れた際に呼び出される。返されたハンドルは他のクライアントで使用することを 想定していない。

制約

引数:
ec_id 解除対象 ExecutionContextハンドル
戻り値:
ReturnCode_t 型のリターンコード

virtual ComponentProfile* RTC::RTObject_impl::get_component_profile (  )  throw (CORBA::SystemException) [virtual]

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

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

戻り値:
コンポーネントプロファイル

virtual PortList* RTC::RTObject_impl::get_ports (  )  throw (CORBA::SystemException) [virtual]

[RTObject CORBA interface] ポートを取得する

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

戻り値:
ポートリスト

virtual ExecutionContextServiceList* RTC::RTObject_impl::get_execution_context_services (  )  throw (CORBA::SystemException) [virtual]

[RTObject CORBA interface] ExecutionContextAdmin を取得する

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

戻り値:
ExecutionContextService リスト

virtual ReturnCode_t RTC::RTObject_impl::on_initialize (  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC の初期化

RTC が初期化され、Alive 状態に遷移する。 RTC 固有の初期化処理はここで実行する。 このオペレーション呼び出しの結果として onInitialize() コールバック関数が 呼び出される。

戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_finalize (  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC の終了

RTC が破棄される。 RTC 固有の終了処理はここで実行する。 このオペレーション呼び出しの結果として onFinalize() コールバック関数が 呼び出される。

戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_startup ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC の開始

RTC が所属する ExecutionContext が Stopped 状態から Running 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onStartup() コールバック関数が 呼び出される。

引数:
ec_id 状態遷移した ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_shutdown ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC の停止

RTC が所属する ExecutionContext が Running 状態から Stopped 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onShutdown() コールバック関数が 呼び出される。

引数:
ec_id 状態遷移した ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_activated ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC の活性化

所属する ExecutionContext から RTC が活性化された際に呼び出される。 このオペレーション呼び出しの結果として onActivated() コールバック関数が 呼び出される。

引数:
ec_id 活性化 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_deactivated ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC の非活性化

所属する ExecutionContext から RTC が非活性化された際に呼び出される。 このオペレーション呼び出しの結果として onDeactivated() コールバック関数が 呼び出される。

引数:
ec_id 非活性化 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_aborting ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC のエラー状態への遷移

RTC が所属する ExecutionContext が Active 状態から Error 状態へ遷移した 場合に呼び出される。 このオペレーションは RTC が Error 状態に遷移した際に一度だけ呼び出される。 このオペレーション呼び出しの結果として onAborting() コールバック関数が 呼び出される。

引数:
ec_id 状態遷移した ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_error ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC のエラー処理

RTC がエラー状態にいる際に呼び出される。 RTC がエラー状態の場合に、対象となる ExecutionContext のExecutionKind に 応じたタイミングで呼び出される。例えば、

引数:
ec_id 対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_reset ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[ComponentAction CORBA interface] RTC のリセット

Error 状態にある RTC のリカバリ処理を実行し、Inactive 状態に復帰させる 場合に呼び出される。 RTC のリカバリ処理が成功した場合は Inactive 状態に復帰するが、それ以外の 場合には Error 状態に留まる。 このオペレーション呼び出しの結果として onReset() コールバック関数が呼び 出される。

引数:
ec_id リセット対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_execute ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)

以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。

制約

引数:
ec_id 定常処理対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_state_update ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)

以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。

制約

引数:
ec_id 定常処理対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual ReturnCode_t RTC::RTObject_impl::on_rate_changed ( UniqueId  ec_id  )  throw (CORBA::SystemException) [virtual]

[DataFlowComponentAction CORBA interface] 実行周期変更通知

本オペレーションは、ExecutionContext の実行周期が変更されたことを通知する 際に呼び出される。 このオペレーション呼び出しの結果として onRateChanged() コールバック関数が 呼び出される。

制約

引数:
ec_id 定常処理対象 ExecutionContext の ID
戻り値:
ReturnCode_t 型のリターンコード

virtual SDOPackage::OrganizationList* RTC::RTObject_impl::get_owned_organizations (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable) [virtual]

[SDO interface] Organization リストの取得

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

戻り値:
所有している Organization リスト
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual char* RTC::RTObject_impl::get_sdo_id (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO interface] SDO ID の取得

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

戻り値:
リソースデータモデルで定義されている SDO の ID
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual char* RTC::RTObject_impl::get_sdo_type (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO interface] SDO タイプの取得

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

戻り値:
リソースデータモデルで定義されている SDO の Type
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::DeviceProfile* RTC::RTObject_impl::get_device_profile (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

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

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

戻り値:
SDO DeviceProfile
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::ServiceProfileList* RTC::RTObject_impl::get_service_profiles (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO interface] SDO ServiceProfile の取得

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

戻り値:
SDO が提供する全ての Service の ServiceProfile。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::ServiceProfile* RTC::RTObject_impl::get_service_profile ( const char *  id  )  throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO interface] 特定のServiceProfileの取得

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

引数:
id SDO Service の ServiceProfile に関連付けられた識別子。
戻り値:
指定された SDO Service の ServiceProfile。
例外:
InvalidParameter "id" で指定した ServiceProfile が存在しない。 "id" が null。
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::SDOService_ptr RTC::RTObject_impl::get_sdo_service ( const char *  id  )  throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

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

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

引数:
id SDO Service に関連付けられた識別子。
戻り値:
要求された SDO Service への参照。
例外:
InvalidParameter "id" で指定した ServiceProfile が存在しない。 "id" が null。
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::Configuration_ptr RTC::RTObject_impl::get_configuration (  )  throw (CORBA::SystemException, SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO 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が存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::Monitoring_ptr RTC::RTObject_impl::get_monitoring (  )  throw (CORBA::SystemException, SDOPackage::InterfaceNotImplemented, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO 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が存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::OrganizationList* RTC::RTObject_impl::get_organizations (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO interface] Organization リストの取得

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

戻り値:
SDO が所属する Organization のリスト。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual SDOPackage::NVList* RTC::RTObject_impl::get_status_list (  )  throw (CORBA::SystemException, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

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

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

戻り値:
SDO のステータス。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InternalError 内部的エラーが発生した。

virtual CORBA::Any* RTC::RTObject_impl::get_status ( const char *  name  )  throw (CORBA::SystemException, SDOPackage::InvalidParameter, SDOPackage::NotAvailable, SDOPackage::InternalError) [virtual]

[SDO interface] SDO Status の取得

This operation returns the value of the specified status parameter.

引数:
name SDO のステータスを定義するパラメータ。
戻り値:
指定されたパラメータのステータス値。
例外:
SDONotExists ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる)
NotAvailable SDOは存在するが応答がない。
InvalidParameter 引数 "name" が null あるいは存在しない。
InternalError 内部的エラーが発生した。

const char* RTC::RTObject_impl::getInstanceName (  )  [inline]

[local interface] インスタンス名の取得

ComponentProfile に設定されたインスタンス名を返す。

戻り値:
インスタンス名

void RTC::RTObject_impl::setInstanceName ( const char *  instance_name  ) 

[local interface] インスタンス名の設定

ComponentProfile に指定されたインスタンス名を設定する。

引数:
instance_name インスタンス名

const char* RTC::RTObject_impl::getTypeName (  )  [inline]

[local interface] 型名の取得

ComponentProfile に設定された型名を返す。

戻り値:
型名

const char* RTC::RTObject_impl::getDescription (  )  [inline]

[local interface] Description の取得

ComponentProfile に設定された Description を返す。

戻り値:
Description

const char* RTC::RTObject_impl::getVersion (  )  [inline]

[local interface] バージョン情報の取得

ComponentProfile に設定されたバージョン情報を返す。

戻り値:
バージョン情報

const char* RTC::RTObject_impl::getVendor (  )  [inline]

[local interface] ベンダー情報の取得

ComponentProfile に設定されたベンダー情報を返す。

戻り値:
ベンダー情報

const char* RTC::RTObject_impl::getCategory (  )  [inline]

[local interface] カテゴリ情報の取得

ComponentProfile に設定されたカテゴリ情報を返す。

戻り値:
カテゴリ情報

std::vector<std::string> RTC::RTObject_impl::getNamingNames (  ) 

[local interface] Naming Server 情報の取得

設定された Naming Server 情報を返す。

戻り値:
Naming Server リスト

void RTC::RTObject_impl::setObjRef ( const RTObject_ptr  rtobj  ) 

[local interface] オブジェクトリファレンスの設定

RTC の CORBA オブジェクトリファレンスを設定する。

引数:
rtobj オブジェクトリファレンス

RTObject_ptr RTC::RTObject_impl::getObjRef (  )  const

[local interface] オブジェクトリファレンスの取得

設定された CORBA オブジェクトリファレンスを取得する。

戻り値:
オブジェクトリファレンス

void RTC::RTObject_impl::setProperties ( const Properties prop  ) 

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

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

引数:
prop RTC のプロパティ

Properties& RTC::RTObject_impl::getProperties (  ) 

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

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

戻り値:
RTC のプロパティ

template<typename VarType>
bool RTC::RTObject_impl::bindParameter ( const char *  param_name,
VarType &  var,
const char *  def_val,
bool(*)(VarType &, const char *)  trans = ::stringTo 
) [inline]

コンフィギュレーションパラメータの設定

コンフィギュレーションパラメータと変数をバインドする <VarType>としてコンフィギュレーションパラメータのデータ型を指定する。

引数:
param_name コンフィギュレーションパラメータ名
var コンフィギュレーションパラメータ格納用変数
def_val コンフィギュレーションパラメータデフォルト値
trans コンフィギュレーションパラメータ文字列変換用関数
戻り値:
設定結果(設定成功:true,設定失敗:false)

void RTC::RTObject_impl::updateParameters ( const char *  config_set  ) 

コンフィギュレーションパラメータの更新(ID指定)

指定したIDのコンフィギュレーションセットに設定した値で、 コンフィギュレーションパラメータの値を更新する

引数:
config_set 設定対象のコンフィギュレーションセットID

void RTC::RTObject_impl::registerPort ( PortBase port  ) 

[local interface] Port を登録する

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

引数:
port RTC に登録する Port

template<class DataType, template< class DataType > class Buffer>
void RTC::RTObject_impl::registerInPort ( const char *  name,
InPort< DataType, Buffer > &  inport 
) [inline]

[local interface] DataInPort を登録する

RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。

引数:
name port 名称
inport 登録対象 DataInPort

template<class DataType, template< class DataType > class Buffer>
void RTC::RTObject_impl::registerOutPort ( const char *  name,
OutPort< DataType, Buffer > &  outport 
) [inline]

[local interface] DataOutPort を登録する

RTC が保持する DataOutPortを登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataOutPort の インスタンスを生成し、登録する。

引数:
name port 名称
outport 登録対象 DataOutPort

void RTC::RTObject_impl::deletePort ( PortBase port  ) 

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

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

引数:
port 削除対象 Port

void RTC::RTObject_impl::deletePortByName ( const char *  port_name  ) 

[local interface] 名前指定により Port の登録を削除する

名称を指定して RTC が保持するPortの登録を削除する。

引数:
port_name 削除対象 Port 名

void RTC::RTObject_impl::finalizePorts (  ) 

全 Port の登録を削除する

RTC が保持する全ての Port を削除する。

void RTC::RTObject_impl::shutdown (  )  [protected]

RTC を終了する

RTC の終了処理を実行する。 保持している全 Port の登録を解除するとともに、該当する CORBA オブジェクト を非活性化し、RTC を終了する。


変数

Manager* RTC::RTObject_impl::m_pManager [protected]

マネージャオブジェクト

CORBA::ORB_var RTC::RTObject_impl::m_pORB [protected]

ORB へのポインタ

PortableServer::POA_var RTC::RTObject_impl::m_pPOA [protected]

POA へのポインタ

SDOPackage::OrganizationList RTC::RTObject_impl::m_sdoOwnedOrganizations [protected]

SDO が保持する organization のリスト

SDOPackage::ServiceProfileList RTC::RTObject_impl::m_sdoSvcProfiles [protected]

SDOService のプロファイルリスト

SDOPackage::Configuration_impl* RTC::RTObject_impl::m_pSdoConfigImpl [protected]

SDO Configuration オブジェクトへのポインタ

SDOPackage::Configuration_var RTC::RTObject_impl::m_pSdoConfig [protected]

SDO Configuration Interface へのポインタ

SDOPackage::OrganizationList RTC::RTObject_impl::m_sdoOrganizations [protected]

SDO organization

SDOPackage::NVList RTC::RTObject_impl::m_sdoStatus [protected]

SDO Status

ComponentProfile RTC::RTObject_impl::m_profile [protected]

コンポーネントプロファイル

RTObject_ptr RTC::RTObject_impl::m_objref [protected]

オブジェクトリファレンス

PortAdmin RTC::RTObject_impl::m_portAdmin [protected]

Port のオブジェクトリファレンスのリスト

ExecutionContextServiceList RTC::RTObject_impl::m_execContexts [protected]

ExecutionContextService のリスト

bool RTC::RTObject_impl::m_created [protected]

Created 状態フラグ

bool RTC::RTObject_impl::m_alive [protected]

Alive 状態フラグ

Properties RTC::RTObject_impl::m_properties [protected]

RTC のプロパティ

ConfigAdmin RTC::RTObject_impl::m_configsets [protected]

コンフィギュレーション情報管理オブジェクト


OpenRTMに対してWed May 21 05:17:25 2008に生成されました。  doxygen 1.5.3