RTコンポーネントクラス. [詳細]
構成 | |
class | deactivate_comps |
RTC 非活性化用ファンクタ. [詳細] | |
class | ec_copy |
ExecutionContext Copy用ファンクタ. [詳細] | |
class | ec_find |
ExecutionContext 検索用ファンクタ. [詳細] | |
class | nv_name |
NVList 検索用ファンクタ. [詳細] | |
class | svc_name |
SDOService のプロファイルリストからidでサーチするための ファンクタクラス. [詳細] | |
Public メソッド | |
def | __init__ |
コンストラクタ | |
def | __del__ |
デストラクタ | |
def | onInitialize |
初期化処理用コールバック関数 | |
def | onFinalize |
終了処理用コールバック関数 | |
def | onStartup |
開始処理用コールバック関数 | |
def | onShutdown |
停止処理用コールバック関数 | |
def | onActivated |
活性化処理用コールバック関数 | |
def | onDeactivated |
非活性化処理用コールバック関数 | |
def | onExecute |
周期処理用コールバック関数 | |
def | onAborting |
中断処理用コールバック関数 | |
def | onError |
エラー処理用コールバック関数 | |
def | onReset |
リセット処理用コールバック関数 | |
def | onStateUpdate |
状態変更処理用コールバック関数 | |
def | onRateChanged |
動作周期変更通知用コールバック関数 | |
def | initialize |
[CORBA interface] RTCを初期化する | |
def | finalize |
[CORBA interface] RTC を終了する | |
def | exit |
[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる | |
def | is_alive |
[CORBA interface] RTC が Alive 状態であるかどうか確認する。 | |
def | get_context |
[CORBA interface] ExecutionContextListを取得する | |
def | get_owned_contexts |
[CORBA interface] 所有する ExecutionContextListを 取得する | |
def | get_participating_contexts |
[CORBA interface] 参加している ExecutionContextList を取得する | |
def | get_component_profile |
[RTObject CORBA interface] コンポーネントプロファイルを取得する | |
def | get_ports |
[RTObject CORBA interface] ポートを取得する | |
def | attach_context |
[CORBA interface] ExecutionContextをattachする | |
def | detach_context |
[CORBA interface] ExecutionContextをdetachする | |
def | on_initialize |
[ComponentAction CORBA interface] RTC の初期化 | |
def | on_finalize |
[ComponentAction CORBA interface] RTC の終了 | |
def | on_startup |
[ComponentAction CORBA interface] RTC の開始 | |
def | on_shutdown |
[ComponentAction CORBA interface] RTC の停止 | |
def | on_activated |
[ComponentAction CORBA interface] RTC の活性化 | |
def | on_deactivated |
[ComponentAction CORBA interface] RTC の非活性化 | |
def | on_aborting |
[ComponentAction CORBA interface] RTC のエラー状態への遷移 | |
def | on_error |
[ComponentAction CORBA interface] RTC のエラー処理 | |
def | on_reset |
[ComponentAction CORBA interface] RTC のリセット | |
def | on_execute |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期) | |
def | on_state_update |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期) | |
def | on_rate_changed |
[DataFlowComponentAction CORBA interface] 実行周期変更通知 | |
def | get_owned_organizations |
[SDO interface] Organization リストの取得 | |
def | get_sdo_id |
[SDO interface] SDO ID の取得 | |
def | get_sdo_type |
[SDO interface] SDO タイプの取得 | |
def | get_device_profile |
[SDO interface] SDO DeviceProfile リストの取得 | |
def | get_service_profiles |
[SDO interface] SDO ServiceProfile の取得 | |
def | get_service_profile |
[SDO interface] 特定のServiceProfileの取得 | |
def | get_sdo_service |
[SDO interface] 指定された SDO Service の取得 | |
def | get_configuration |
[SDO interface] Configuration オブジェクトの取得 | |
def | get_monitoring |
[SDO interface] Monitoring オブジェクトの取得 | |
def | get_organizations |
[SDO interface] Organization リストの取得 | |
def | get_status_list |
[SDO interface] SDO Status リストの取得 | |
def | get_status |
[SDO interface] SDO Status の取得 | |
def | getInstanceName |
[local interface] インスタンス名の取得 | |
def | setInstanceName |
[local interface] インスタンス名の設定 | |
def | getTypeName |
[local interface] 型名の取得 | |
def | getDescription |
[local interface] Description の取得 | |
def | getVersion |
[local interface] バージョン情報の取得 | |
def | getVendor |
[local interface] ベンダー情報の取得 | |
def | getCategory |
[local interface] カテゴリ情報の取得 | |
def | getNamingNames |
[local interface] Naming Server 情報の取得 | |
def | setObjRef |
[local interface] オブジェクトリファレンスの設定 | |
def | getObjRef |
[local interface] オブジェクトリファレンスの取得 | |
def | setProperties |
[local interface] RTC のプロパティを設定する | |
def | getProperties |
[local interface] RTC のプロパティを取得する | |
def | bindParameter |
コンフィギュレーションパラメータの設定 | |
def | updateParameters |
コンフィギュレーションパラメータの更新(ID指定) | |
def | registerPort |
[local interface] Port を登録する | |
def | registerInPort |
[local interface] DataInPort を登録する | |
def | registerOutPort |
[local interface] DataOutPort を登録する | |
def | removeInPort |
[local interface] InPort の登録を削除する | |
def | removeOutPort |
[local interface] OutPort の登録を削除する | |
def | deletePort |
[local interface] Port の登録を削除する | |
def | deletePortByName |
[local interface] 名前指定により Port の登録を削除する | |
def | readAll |
全 InPort のデータを読み込む。 | |
def | writeAll |
全 OutPort のwrite()メソッドをコールする。 | |
def | setReadAll |
onExecute()実行前でのreadAll()メソッドの呼出を有効または無効にする。 | |
def | setWriteAll |
onExecute()実行後にwriteAll()メソッドの呼出を有効または無効にする。 | |
def | finalizePorts |
全 Port の登録を削除する | |
def | shutdown |
RTC を終了する. |
RTコンポーネントクラス.
各RTコンポーネントのベースとなるクラス。 Robotic Technology Component 仕様中の lightweightRTComponentの実装クラス。 コンポーネントの機能を提供する ComponentAction インターフェースと コンポーネントのライフサイクル管理を行うための LightweightRTObject の実装を 提供する。 実際にユーザがコンポーネントを作成する場合には、Execution Semantics に対応 した各サブクラスを利用する。
(現状の実装では Periodic Sampled Data Processing のみサポートしているため、 dataFlowComponent を直接継承している)
def OpenRTM_aist.RTObject.RTObject_impl.__del__ | ( | self | ) |
def OpenRTM_aist.RTObject.RTObject_impl.__init__ | ( | self, | ||
manager = None , |
||||
orb = None , |
||||
poa = None | ||||
) |
コンストラクタ
コンストラクタ
self | ||
manager | マネージャオブジェクト(デフォルト値:None) | |
orb | ORB(デフォルト値:None) | |
poa | POA(デフォルト値:None) |
def OpenRTM_aist.RTObject.RTObject_impl.attach_context | ( | self, | ||
exec_context | ||||
) |
[CORBA interface] ExecutionContextをattachする
指定した ExecutionContext にこの RTC を所属させる。この RTC と関連する ExecutionContext のハンドルを返す。 このオペレーションは、ExecutionContextOperationsadd_component が呼ばれた 際に呼び出される。返されたハンドルは他のクライアントで使用することを想定 していない。
self | ||
exec_context | 所属先 ExecutionContext |
UniqueId attach_context(ExecutionContext_ptr exec_context)
def OpenRTM_aist.RTObject.RTObject_impl.bindParameter | ( | self, | ||
param_name, | ||||
var, | ||||
def_val, | ||||
trans = None | ||||
) |
コンフィギュレーションパラメータの設定
コンフィギュレーションパラメータと変数をバインドする <VarType>としてコンフィギュレーションパラメータのデータ型を指定する。
self | ||
param_name | コンフィギュレーションパラメータ名 | |
var | コンフィギュレーションパラメータ格納用変数 | |
def_val | コンフィギュレーションパラメータデフォルト値 | |
trans | 文字列変換用関数(デフォルト値:None) |
template <typename vartype>=""> bool bindParameter(const char* param_name, VarType& var, const char* def_val, bool (*trans)(VarType&, const char*) = coil.stringTo)
def OpenRTM_aist.RTObject.RTObject_impl.deletePort | ( | self, | ||
port | ||||
) |
[local interface] Port の登録を削除する
RTC が保持するPortの登録を削除する。
self | ||
port | 削除対象 Port |
void RTObject_impl.deletePort(PortBase& port)
def OpenRTM_aist.RTObject.RTObject_impl.deletePortByName | ( | self, | ||
port_name | ||||
) |
[local interface] 名前指定により Port の登録を削除する
名称を指定して RTC が保持するPortの登録を削除する。
self | ||
port_name | 削除対象 Port 名 |
def OpenRTM_aist.RTObject.RTObject_impl.detach_context | ( | self, | ||
ec_id | ||||
) |
[CORBA interface] ExecutionContextをdetachする
指定した ExecutionContext からこの RTC の所属を解除する。 このオペレーションは、ExecutionContextOperationsremove_component が呼ば れた際に呼び出される。返されたハンドルは他のクライアントで使用することを 想定していない。
制約
self | ||
ec_id | 解除対象 ExecutionContextハンドル |
ReturnCode_t detach_context(UniqueId exec_handle)
def OpenRTM_aist.RTObject.RTObject_impl.exit | ( | self | ) |
[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる
この RTC がオーナーであるすべての実行コンテキストを停止する。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければならない。 RTC が実行中のどの ExecutionContext でも Active 状態ではなくなった後、 この RTC とこれに含まれる RTC が終了する。
制約
self |
def OpenRTM_aist.RTObject.RTObject_impl.finalize | ( | self | ) |
[CORBA interface] RTC を終了する
このオペレーション呼び出しの結果として ComponentAction.on_finalize() を呼び出す。
制約
self |
def OpenRTM_aist.RTObject.RTObject_impl.finalizePorts | ( | self | ) |
def OpenRTM_aist.RTObject.RTObject_impl.get_component_profile | ( | self | ) |
[RTObject CORBA interface] コンポーネントプロファイルを取得する
当該コンポーネントのプロファイル情報を返す。
self |
virtual ComponentProfile* get_component_profile()
def OpenRTM_aist.RTObject.RTObject_impl.get_configuration | ( | self | ) |
[SDO interface] Configuration オブジェクトの取得
このオペレーションは Configuration interface への参照を返す。 Configuration interface は各 SDO を管理するためのインターフェースの ひとつである。このインターフェースは DeviceProfile, ServiceProfile, Organization で定義された SDO の属性値を設定するために使用される。 Configuration インターフェースの詳細については、OMG SDO specification の 2.3.5節, p.2-24 を参照のこと。
self |
InterfaceNotImplemented | SDOはConfigurationインターフェースを 持たない。 | |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.Configuration_ptr get_configuration()
def OpenRTM_aist.RTObject.RTObject_impl.get_context | ( | self, | ||
ec_id | ||||
) |
[CORBA interface] ExecutionContextListを取得する
この RTC が所有する ExecutionContext のリストを取得する。
self |
def get_contexts(self): execlist = [] OpenRTM_aist.CORBA_SeqUtil.for_each(self._execContexts, self.ec_copy(execlist)) return execlist
[CORBA interface] ExecutionContextを取得する 指定したハンドルの ExecutionContext を取得する。 ハンドルから ExecutionContext へのマッピングは、特定の RTC インスタンスに 固有である。ハンドルはこの RTC を attach_context した際に取得できる。
self | ||
ec_id | 取得対象 ExecutionContext ハンドル |
virtual ExecutionContext_ptr get_context(UniqueId exec_handle)
def OpenRTM_aist.RTObject.RTObject_impl.get_device_profile | ( | self | ) |
[SDO interface] SDO DeviceProfile リストの取得
SDO の DeviceProfile を返すオペレーション。 SDO がハードウエアデバイス に関連付けられていない場合には、空の DeviceProfile が返される。 このオペレーションは以下の型の例外を発生させる。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.DeviceProfile* get_device_profile()
def OpenRTM_aist.RTObject.RTObject_impl.get_monitoring | ( | self | ) |
[SDO interface] Monitoring オブジェクトの取得
このオペレーションは Monitoring interface への参照を返す。 Monitoring interface は SDO が管理するインターフェースの一つである。 このインターフェースは SDO のプロパティをモニタリングするために 使用される。 Monitoring interface の詳細については OMG SDO specification の 2.3.7節 "Monitoring Interface" p.2-35 を参照のこと。
self |
InterfaceNotImplemented | SDOはConfigurationインターフェースを 持たない。 | |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.Monitoring_ptr get_monitoring()
def OpenRTM_aist.RTObject.RTObject_impl.get_organizations | ( | self | ) |
[SDO interface] Organization リストの取得
SDO は0個以上の Organization (組織)に所属することができる。 もし SDO が 1個以上の Organization に所属している場合、このオペレーションは所属する Organization のリストを返す。SDO が どの Organization にも所属していない 場合には、空のリストが返される。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.OrganizationList* get_organizations()
def OpenRTM_aist.RTObject.RTObject_impl.get_owned_contexts | ( | self | ) |
[CORBA interface] 所有する ExecutionContextListを 取得する
この RTC が所有する ExecutionContext のリストを取得する。
virtual ExecutionContextList* get_owned_contexts()
def OpenRTM_aist.RTObject.RTObject_impl.get_owned_organizations | ( | self | ) |
[SDO interface] Organization リストの取得
SDOSystemElement は0個もしくはそれ以上の Organization を所有することが 出来る。 SDOSystemElement が1つ以上の Organization を所有している場合 には、このオペレーションは所有する Organization のリストを返す。 もしOrganizationを一つも所有していないければ空のリストを返す。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.OrganizationList* get_owned_organizations()
def OpenRTM_aist.RTObject.RTObject_impl.get_participating_contexts | ( | self | ) |
[CORBA interface] 参加している ExecutionContextList を取得する
この RTC が参加している ExecutionContext のリストを取得する。
virtual ExecutionContextList* get_participating_contexts()
def OpenRTM_aist.RTObject.RTObject_impl.get_ports | ( | self | ) |
[RTObject CORBA interface] ポートを取得する
当該コンポーネントが保有するポートの参照を返す。
self |
virtual PortServiceList* get_ports()
def OpenRTM_aist.RTObject.RTObject_impl.get_sdo_id | ( | self | ) |
[SDO interface] SDO ID の取得
SDO ID を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual char* get_sdo_id()
def OpenRTM_aist.RTObject.RTObject_impl.get_sdo_service | ( | self, | ||
_id | ||||
) |
[SDO interface] 指定された SDO Service の取得
このオペレーションは引数 "id" で指定された名前によって区別される SDO の Service へのオブジェクト参照を返す。 SDO により提供される Service はそれぞれ一意の識別子により区別される。
self | ||
_id | SDO Service に関連付けられた識別子。 |
InvalidParameter | "id" で指定した ServiceProfile が存在しない。 "id" が null。 | |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.SDOService_ptr get_sdo_service(const char* id)
def OpenRTM_aist.RTObject.RTObject_impl.get_sdo_type | ( | self | ) |
[SDO interface] SDO タイプの取得
SDO Type を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual char* get_sdo_type()
def OpenRTM_aist.RTObject.RTObject_impl.get_service_profile | ( | self, | ||
_id | ||||
) |
[SDO interface] 特定のServiceProfileの取得
引数 "id" で指定された名前のサービスの ServiceProfile を返す。
self | ||
_id | SDO Service の ServiceProfile に関連付けられた識別子。 |
InvalidParameter | "id" で指定した ServiceProfile が存在しない。 "id" が null。 | |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.ServiceProfile* get_service_profile(const char* id)
def OpenRTM_aist.RTObject.RTObject_impl.get_service_profiles | ( | self | ) |
[SDO interface] SDO ServiceProfile の取得
SDO が所有している Service の ServiceProfile を返すオペレーション。 SDO がサービスを一つも所有していない場合には、空のリストを返す。 このオペレーションは以下の型の例外を発生させる。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.ServiceProfileList* get_service_profiles()
def OpenRTM_aist.RTObject.RTObject_impl.get_status | ( | self, | ||
name | ||||
) |
[SDO interface] SDO Status の取得
This operation returns the value of the specified status parameter.
self | ||
name | SDO のステータスを定義するパラメータ。 |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InvalidParameter | 引数 "name" が null あるいは存在しない。 | |
InternalError | 内部的エラーが発生した。 |
virtual CORBA.Any* get_status(const char* name)
def OpenRTM_aist.RTObject.RTObject_impl.get_status_list | ( | self | ) |
[SDO interface] SDO Status リストの取得
このオペレーションは SDO のステータスを表す NVList を返す。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) | |
NotAvailable | SDOは存在するが応答がない。 | |
InternalError | 内部的エラーが発生した。 |
virtual SDOPackage.NVList* get_status_list()
def OpenRTM_aist.RTObject.RTObject_impl.getCategory | ( | self | ) |
[local interface] カテゴリ情報の取得
ComponentProfile に設定されたカテゴリ情報を返す。
self |
const char* getCategory()
def OpenRTM_aist.RTObject.RTObject_impl.getDescription | ( | self | ) |
[local interface] Description の取得
ComponentProfile に設定された Description を返す。
self |
const char* getDescription()
def OpenRTM_aist.RTObject.RTObject_impl.getInstanceName | ( | self | ) |
[local interface] インスタンス名の取得
ComponentProfile に設定されたインスタンス名を返す。
self |
const char* getInstanceName()
def OpenRTM_aist.RTObject.RTObject_impl.getNamingNames | ( | self | ) |
[local interface] Naming Server 情報の取得
設定された Naming Server 情報を返す。
self |
std.vector<std.string> getNamingNames();
def OpenRTM_aist.RTObject.RTObject_impl.getObjRef | ( | self | ) |
[local interface] オブジェクトリファレンスの取得
設定された CORBA オブジェクトリファレンスを取得する。
self |
RTObject_ptr getObjRef() const;
def OpenRTM_aist.RTObject.RTObject_impl.getProperties | ( | self | ) |
[local interface] RTC のプロパティを取得する
RTC が保持しているプロパティを返す。 RTCがプロパティを持たない場合は空のプロパティが返される。
self |
coil.Properties& getProperties();
def OpenRTM_aist.RTObject.RTObject_impl.getTypeName | ( | self | ) |
def OpenRTM_aist.RTObject.RTObject_impl.getVendor | ( | self | ) |
[local interface] ベンダー情報の取得
ComponentProfile に設定されたベンダー情報を返す。
self |
const char* getVendor()
def OpenRTM_aist.RTObject.RTObject_impl.getVersion | ( | self | ) |
[local interface] バージョン情報の取得
ComponentProfile に設定されたバージョン情報を返す。
self |
const char* getVersion()
def OpenRTM_aist.RTObject.RTObject_impl.initialize | ( | self | ) |
def OpenRTM_aist.RTObject.RTObject_impl.is_alive | ( | self, | ||
exec_context | ||||
) |
[CORBA interface] RTC が Alive 状態であるかどうか確認する。
RTC が指定した ExecutionContext に対して Alive状態であるかどうか確認する。 RTC の状態が Active であるか、Inactive であるか、Error であるかは実行中の ExecutionContext に依存する。すなわち、ある ExecutionContext に対しては Active 状態であっても、他の ExecutionContext に対しては Inactive 状態と なる場合もありえる。従って、このオペレーションは指定された ExecutionContext に問い合わせて、この RTC の状態が Active、Inactive、 Error の場合には Alive 状態として返す。
self | ||
exec_context | 取得対象 ExecutionContext ハンドル |
virtual CORBA.Boolean is_alive(ExecutionContext_ptr exec_context)
def OpenRTM_aist.RTObject.RTObject_impl.on_aborting | ( | self, | ||
ec_id | ||||
) |
[ComponentAction CORBA interface] RTC のエラー状態への遷移
RTC が所属する ExecutionContext が Active 状態から Error 状態へ遷移した 場合に呼び出される。 このオペレーションは RTC が Error 状態に遷移した際に一度だけ呼び出される。 このオペレーション呼び出しの結果として onAborting() コールバック関数が 呼び出される。
self | ||
ec_id | 状態遷移した ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_activated | ( | self, | ||
ec_id | ||||
) |
[ComponentAction CORBA interface] RTC の活性化
所属する ExecutionContext から RTC が活性化された際に呼び出される。 このオペレーション呼び出しの結果として onActivated() コールバック関数が 呼び出される。
self | ||
ec_id | 活性化 ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_deactivated | ( | self, | ||
ec_id | ||||
) |
[ComponentAction CORBA interface] RTC の非活性化
所属する ExecutionContext から RTC が非活性化された際に呼び出される。 このオペレーション呼び出しの結果として onDeactivated() コールバック関数が 呼び出される。
self | ||
ec_id | 非活性化 ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_error | ( | self, | ||
ec_id | ||||
) |
[ComponentAction CORBA interface] RTC のエラー処理
RTC がエラー状態にいる際に呼び出される。 RTC がエラー状態の場合に、対象となる ExecutionContext のExecutionKind に 応じたタイミングで呼び出される。例えば、
self | ||
ec_id | 対象 ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_execute | ( | self, | ||
ec_id | ||||
) |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)
以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。
制約
self | ||
ec_id | 定常処理対象 ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_finalize | ( | self | ) |
[ComponentAction CORBA interface] RTC の終了
RTC が破棄される。 RTC 固有の終了処理はここで実行する。 このオペレーション呼び出しの結果として onFinalize() コールバック関数が 呼び出される。
self |
def OpenRTM_aist.RTObject.RTObject_impl.on_initialize | ( | self | ) |
[ComponentAction CORBA interface] RTC の初期化
RTC が初期化され、Alive 状態に遷移する。 RTC 固有の初期化処理はここで実行する。 このオペレーション呼び出しの結果として onInitialize() コールバック関数が 呼び出される。
self |
def OpenRTM_aist.RTObject.RTObject_impl.on_rate_changed | ( | self, | ||
ec_id | ||||
) |
[DataFlowComponentAction CORBA interface] 実行周期変更通知
本オペレーションは、ExecutionContext の実行周期が変更されたことを通知する 際に呼び出される。 このオペレーション呼び出しの結果として onRateChanged() コールバック関数が 呼び出される。
制約
self | ||
ec_id | 定常処理対象 ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_reset | ( | self, | ||
ec_id | ||||
) |
def OpenRTM_aist.RTObject.RTObject_impl.on_shutdown | ( | self, | ||
ec_id | ||||
) |
[ComponentAction CORBA interface] RTC の停止
RTC が所属する ExecutionContext が Running 状態から Stopped 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onShutdown() コールバック関数が 呼び出される。
self | ||
ec_id | 状態遷移した ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_startup | ( | self, | ||
ec_id | ||||
) |
[ComponentAction CORBA interface] RTC の開始
RTC が所属する ExecutionContext が Stopped 状態から Running 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onStartup() コールバック関数が 呼び出される。
self | ||
ec_id | 状態遷移した ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.on_state_update | ( | self, | ||
ec_id | ||||
) |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)
以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。
制約
self | ||
ec_id | 定常処理対象 ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onAborting | ( | self, | ||
ec_id | ||||
) |
中断処理用コールバック関数
ComponentAction.on_aborting が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の中断処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onActivated | ( | self, | ||
ec_id | ||||
) |
活性化処理用コールバック関数
ComponentAction.on_activated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の活性化処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedCompositeで再定義されています。
def OpenRTM_aist.RTObject.RTObject_impl.onDeactivated | ( | self, | ||
ec_id | ||||
) |
非活性化処理用コールバック関数
ComponentAction.on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の非活性化処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedCompositeで再定義されています。
def OpenRTM_aist.RTObject.RTObject_impl.onError | ( | self, | ||
ec_id | ||||
) |
エラー処理用コールバック関数
ComponentAction.on_error が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のエラー処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onExecute | ( | self, | ||
ec_id | ||||
) |
周期処理用コールバック関数
DataFlowComponentAction.on_execute が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の周期処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 1回目の実行パスとして定期的に呼び出される。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onFinalize | ( | self | ) |
終了処理用コールバック関数
ComponentAction.on_finalize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の終了処理は、本関数をオーバーライドして実装する 必要がある。
self |
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedCompositeで再定義されています。
def OpenRTM_aist.RTObject.RTObject_impl.onInitialize | ( | self | ) |
初期化処理用コールバック関数
ComponentAction.on_initialize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の初期化処理は、本関数をオーバーライドして実装する 必要がある。
self |
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedCompositeで再定義されています。
def OpenRTM_aist.RTObject.RTObject_impl.onRateChanged | ( | self, | ||
ec_id | ||||
) |
動作周期変更通知用コールバック関数
DataFlowComponentAction.on_rate_changed が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing において ExecutionContext の 実行が更新された際に呼び出される。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onReset | ( | self, | ||
ec_id | ||||
) |
リセット処理用コールバック関数
ComponentAction.on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.PeriodicECSharedComposite.PeriodicECSharedCompositeで再定義されています。
def OpenRTM_aist.RTObject.RTObject_impl.onShutdown | ( | self, | ||
ec_id | ||||
) |
停止処理用コールバック関数
ComponentAction.on_shutdown が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の停止処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onStartup | ( | self, | ||
ec_id | ||||
) |
開始処理用コールバック関数
ComponentAction.on_startup が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の開始処理は、本関数をオーバーライドして実装する 必要がある。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.onStateUpdate | ( | self, | ||
ec_id | ||||
) |
状態変更処理用コールバック関数
DataFlowComponentAction.on_state_update が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 2回目の実行パスとして定期的に呼び出される。
self | ||
ec_id | 参加している ExecutionContext の ID |
def OpenRTM_aist.RTObject.RTObject_impl.readAll | ( | self | ) |
def OpenRTM_aist.RTObject.RTObject_impl.registerInPort | ( | self, | ||
name, | ||||
inport | ||||
) |
[local interface] DataInPort を登録する
RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。
self | ||
name | port 名称 | |
inport | 登録対象 DataInPort |
def OpenRTM_aist.RTObject.RTObject_impl.registerOutPort | ( | self, | ||
name, | ||||
outport | ||||
) |
[local interface] DataOutPort を登録する
RTC が保持する DataOutPor tを登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataOutPort の インスタンスを生成し、登録する。
self | ||
name | port 名称 | |
outport | 登録対象 DataInPort |
void registerOutPort(const char* name, OutPortBase& outport);
def OpenRTM_aist.RTObject.RTObject_impl.registerPort | ( | self, | ||
port | ||||
) |
[local interface] Port を登録する
RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。
self | ||
port | RTC に登録する Port | |
port_type | if port is PortBase, port_type is None, if port is PortService, port_type is True |
void registerPort(PortBase& port);
def OpenRTM_aist.RTObject.RTObject_impl.removeInPort | ( | self, | ||
port | ||||
) |
[local interface] InPort の登録を削除する
RTC が保持するInPortの登録を削除する。
port | 削除対象 Port |
bool removeInPort(InPortBase& port);
def OpenRTM_aist.RTObject.RTObject_impl.removeOutPort | ( | self, | ||
port | ||||
) |
[local interface] OutPort の登録を削除する
RTC が保持するOutPortの登録を削除する。
port | 削除対象 Port |
bool removeOutPort(OutPortBase& port);
def OpenRTM_aist.RTObject.RTObject_impl.setInstanceName | ( | self, | ||
instance_name | ||||
) |
[local interface] インスタンス名の設定
ComponentProfile に指定されたインスタンス名を設定する。
self | ||
instance_name | インスタンス名 |
void setInstanceName(const char* instance_name);
def OpenRTM_aist.RTObject.RTObject_impl.setObjRef | ( | self, | ||
rtobj | ||||
) |
[local interface] オブジェクトリファレンスの設定
RTC の CORBA オブジェクトリファレンスを設定する。
self | ||
rtobj | オブジェクトリファレンス |
void setObjRef(const RTObject_ptr rtobj);
def OpenRTM_aist.RTObject.RTObject_impl.setProperties | ( | self, | ||
prop | ||||
) |
def OpenRTM_aist.RTObject.RTObject_impl.setReadAll | ( | self, | ||
read = True , |
||||
completion = False | ||||
) |
onExecute()実行前でのreadAll()メソッドの呼出を有効または無効にする。
このメソッドをパラメータをtrueとして呼ぶ事により、onExecute()実行前に readAll()が呼出されるようになる。 パラメータがfalseの場合は、readAll()呼出を無効にする。
read(default:true) | (readAll()メソッド呼出あり:true, readAll()メソッド呼出なし:false) | |
completion(default:false) | readAll()にて、どれかの一つのInPortのread()が失敗しても全てのInPortのread()を呼び出す:true, readAll()にて、どれかの一つのInPortのread()が失敗した場合、すぐにfalseで抜ける:false |
void setReadAll(bool read=true, bool completion=false);
def OpenRTM_aist.RTObject.RTObject_impl.setWriteAll | ( | self, | ||
write = True , |
||||
completion = False | ||||
) |
onExecute()実行後にwriteAll()メソッドの呼出を有効または無効にする。
このメソッドをパラメータをtrueとして呼ぶ事により、onExecute()実行後に writeAll()が呼出されるようになる。 パラメータがfalseの場合は、writeAll()呼出を無効にする。
write(default:true) | (writeAll()メソッド呼出あり:true, writeAll()メソッド呼出なし:false) | |
completion(default:false) | writeAll()にて、どれかの一つのOutPortのwrite()が失敗しても全てのOutPortのwrite()を呼び出しを行う:true, writeAll()にて、どれかの一つのOutPortのwrite()が失敗した場合、すぐにfalseで抜ける:false |
void setWriteAll(bool write=true, bool completion=false);
def OpenRTM_aist.RTObject.RTObject_impl.shutdown | ( | self | ) |
def OpenRTM_aist.RTObject.RTObject_impl.updateParameters | ( | self, | ||
config_set | ||||
) |
コンフィギュレーションパラメータの更新(ID指定)
指定したIDのコンフィギュレーションセットに設定した値で、 コンフィギュレーションパラメータの値を更新する
self | ||
config_set | 設定対象のコンフィギュレーションセットID |
void updateParameters(const char* config_set);
def OpenRTM_aist.RTObject.RTObject_impl.writeAll | ( | self | ) |
全 OutPort のwrite()メソッドをコールする。
RTC が保持する全ての OutPort のwrite()メソッドをコールする。
bool writeAll();