OpenRTM-aist-Python 2.0.2
|
クラス | |
class | deactivate_comps |
class | ec_copy |
class | ec_find |
class | nv_name |
class | svc_name |
公開メンバ関数 | |
__init__ (self, manager=None, orb=None, poa=None) | |
__del__ (self) | |
onInitialize (self) | |
onFinalize (self) | |
onStartup (self, ec_id) | |
onShutdown (self, ec_id) | |
onActivated (self, ec_id) | |
onDeactivated (self, ec_id) | |
onExecute (self, ec_id) | |
onAborting (self, ec_id) | |
onError (self, ec_id) | |
onReset (self, ec_id) | |
onStateUpdate (self, ec_id) | |
onRateChanged (self, ec_id) | |
onAction (self, ec_id) | |
initialize (self) | |
finalize (self) | |
exit (self) | |
is_alive (self, exec_context) | |
get_context (self, ec_id) | |
get_owned_contexts (self) | |
get_participating_contexts (self) | |
get_context_handle (self, cxt) | |
get_component_profile (self) | |
get_ports (self) | |
attach_context (self, exec_context) | |
detach_context (self, ec_id) | |
on_initialize (self) | |
on_finalize (self) | |
on_startup (self, ec_id) | |
on_shutdown (self, ec_id) | |
on_activated (self, ec_id) | |
on_deactivated (self, ec_id) | |
on_aborting (self, ec_id) | |
on_error (self, ec_id) | |
on_reset (self, ec_id) | |
get_owned_organizations (self) | |
get_sdo_id (self) | |
get_sdo_type (self) | |
get_device_profile (self) | |
get_service_profiles (self) | |
get_service_profile (self, _id) | |
get_sdo_service (self, _id) | |
get_configuration (self) | |
get_monitoring (self) | |
get_organizations (self) | |
get_status_list (self) | |
get_status (self, name) | |
getInstanceName (self) | |
setInstanceName (self, instance_name) | |
getTypeName (self) | |
getDescription (self) | |
getVersion (self) | |
getVendor (self) | |
getCategory (self) | |
getNamingNames (self) | |
setObjRef (self, rtobj) | |
getObjRef (self) | |
setProperties (self, prop) | |
getProperties (self) | |
bindParameter (self, param_name, var, def_val, trans=None) | |
getConfigService (self) | |
updateParameters (self, config_set) | |
registerPort (self, port) | |
registerInPort (self, name, inport) | |
registerOutPort (self, name, outport) | |
removeInPort (self, port) | |
removeOutPort (self, port) | |
deletePort (self, port) | |
deletePortByName (self, port_name) | |
getExecutionContext (self, ec_id) | |
getExecutionRate (self, ec_id) | |
setExecutionRate (self, ec_id, rate) | |
isOwnExecutionContext (self, ec_id) | |
deactivate (self, ec_id) | |
activate (self, ec_id) | |
reset (self, ec_id) | |
addSdoServiceProvider (self, prof, provider) | |
removeSdoServiceProvider (self, id) | |
addSdoServiceConsumer (self, prof) | |
removeSdoServiceConsumer (self, id) | |
readAll (self) | |
writeAll (self) | |
setReadAll (self, read=True, completion=False) | |
setWriteAll (self, write=True, completion=False) | |
finalizePorts (self) | |
addPreComponentActionListener (self, listener_type, memfunc) | |
removePreComponentActionListener (self, listener_type, listener) | |
addPostComponentActionListener (self, listener_type, memfunc) | |
removePostComponentActionListener (self, listener_type, listener) | |
addPortActionListener (self, listener_type, memfunc) | |
removePortActionListener (self, listener_type, listener) | |
addExecutionContextActionListener (self, listener_type, memfunc) | |
removeExecutionContextActionListener (self, listener_type, listener) | |
addPortConnectListener (self, listener_type, memfunc) | |
removePortConnectListener (self, listener_type, listener) | |
addPortConnectRetListener (self, listener_type, memfunc) | |
removePortConnectRetListener (self, listener_type, listener) | |
addConfigurationParamListener (self, type, memfunc) | |
removeConfigurationParamListener (self, type, listener) | |
addConfigurationSetListener (self, listener_type, memfunc) | |
removeConfigurationSetListener (self, type, listener) | |
addConfigurationSetNameListener (self, type, memfunc) | |
removeConfigurationSetNameListener (self, type, listener) | |
addPreFsmActionListener (self, listener_type, memfunc) | |
removePreFsmActionListener (self, listener_type, listener) | |
addPostFsmActionListener (self, listener_type, memfunc) | |
removePostFsmActionListener (self, listener_type, listener) | |
addFsmProfileListener (self, listener_type, memfunc) | |
removeFsmProfileListener (self, listener_type, listener) | |
addFsmStructureListener (self, listener_type, memfunc) | |
removeFsmStructureListener (self, listener_type, listener) | |
shutdown (self) | |
getPrivateContextOptions (self, ec_args) | |
getting individual EC options from RTC's configuration file | |
getGlobalContextOptions (self, global_ec_props) | |
getting global EC options from rtc.conf | |
getContextOptions (self, ec_args) | |
getting EC options | |
findExistingEC (self, ec_arg) | |
fiding existing EC from the factory | |
createContexts (self, ec_args) | |
creating, initializing and binding context | |
RTコンポーネントクラス
各RTコンポーネントのベースとなるクラス。 Robotic Technology Component 仕様中の lightweightRTComponentの実装クラス。 コンポーネントの機能を提供する ComponentAction インターフェースと コンポーネントのライフサイクル管理を行うための LightweightRTObject の実装を 提供する。 実際にユーザがコンポーネントを作成する場合には、Execution Semantics に対応 した各サブクラスを利用する。
(現状の実装では Periodic Sampled Data Processing のみサポートしているため、 dataFlowComponent を直接継承している)
OpenRTM_aist.RTObjectBase.RTObjectBase.__init__ | ( | self, | |
manager = None, | |||
orb = None, | |||
poa = None ) |
コンストラクタ
コンストラクタ
self | |
manager | マネージャオブジェクト(デフォルト値:None) |
orb | ORB(デフォルト値:None) |
poa | POA(デフォルト値:None) |
OpenRTM_aist.RTObjectBase.RTObjectBase.__del__ | ( | self | ) |
デストラクタ
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.activate | ( | self, | |
ec_id ) |
[local interface] 状態を Active に遷移させる
状態を Inactive から Active に遷移させる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数は上記の関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
ReturnCode_t activate(RTC.UniqueId ec_id);
OpenRTM_aist.RTObjectBase.RTObjectBase.addConfigurationParamListener | ( | self, | |
type, | |||
memfunc ) |
ConfigurationParamListener を追加する
update(const char* config_set, const char* config_param) が呼ばれた際に コールされるリスナ ConfigurationParamListener を追加する。 type には現在のところ ON_UPDATE_CONFIG_PARAM のみが入る。
type | ConfigurationParamListenerType型の値。 ON_UPDATE_CONFIG_PARAM がある。 |
memfunc | 関数オブジェクト |
template <class Listener> ConfigurationParamListener* addConfigurationParamListener(ConfigurationParamListenerType listener_type, void (Listener::memfunc)(const char, const char*))
OpenRTM_aist.RTObjectBase.RTObjectBase.addConfigurationSetListener | ( | self, | |
listener_type, | |||
memfunc ) |
ConfigurationSetListener を追加する
ConfigurationSet が更新されたときなどに呼ばれるリスナ ConfigurationSetListener を追加する。設定可能なイベントは以下の 2種類がある。
type | ConfigurationSetListenerType型の値。 |
memfunc | 関数オブジェクト |
template <class Listener> ConfigurationSetListener* addConfigurationSetListener(ConfigurationSetListenerType listener_type, void (Listener::*memfunc) (const coil.Properties& config_set))
OpenRTM_aist.RTObjectBase.RTObjectBase.addConfigurationSetNameListener | ( | self, | |
type, | |||
memfunc ) |
ConfigurationSetNameListener を追加する
ConfigurationSetName が更新されたときなどに呼ばれるリスナ ConfigurationSetNameListener を追加する。設定可能なイベントは以下の 3種類がある。
type | ConfigurationSetNameListenerType型の値。 |
memfunc | 関数オブジェクト |
template <class Listener> ConfigurationSetNameListener* addConfigurationSetNameListener(ConfigurationSetNameListenerType type, void (Listener::memfunc)(const char))
OpenRTM_aist.RTObjectBase.RTObjectBase.addExecutionContextActionListener | ( | self, | |
listener_type, | |||
memfunc ) |
ExecutionContextActionListener リスナを追加する
ExecutionContextの追加、削除時にコールバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは ExecutionContextActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
ExecutionContextActionListener.operator()(UniqueId ec_id)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeExecutionContextActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
memfunc | 関数オブジェクト |
template <class Listener> ECActionListener* addExecutionContextActionListener(ECActionListenerType listener_type, void (Listener::*memfunc)(UniqueId));
OpenRTM_aist.RTObjectBase.RTObjectBase.addFsmProfileListener | ( | self, | |
listener_type, | |||
memfunc ) |
FsmProfileListener リスナを追加する
FSMへのプロファイルの設定、取得時、またFSM自体への状態や遷移、イ ベントの追加削除時にコールバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは FsmProfileListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
FsmProfileListener.operator()(RTC.FsmProfile& pprof)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeFsmProfileListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.addFsmStructureListener | ( | self, | |
listener_type, | |||
memfunc ) |
FsmStructureListener リスナを追加する
ExtendedFsmService に関連する FSM structure の設定・取得時にコー ルバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは FsmStructureListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
FsmStructureListener.operator()(FsmStructure& structure)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeFsmStructureListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.addPortActionListener | ( | self, | |
listener_type, | |||
memfunc ) |
PortActionListener リスナを追加する
Portの追加、削除時にコールバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PortActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PortActionListener.operator()(PortProfile& pprof)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
memfunc | 関数オブジェクト |
template <class Listener> PortActionListener* addPortActionListener(PortActionListenerType listener_type, void (Listener::*memfunc)(const RTC.PortProfile&))
OpenRTM_aist.RTObjectBase.RTObjectBase.addPortConnectListener | ( | self, | |
listener_type, | |||
memfunc ) |
PortConnectListener リスナを追加する
Portの接続時や接続解除時に呼び出される各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PortConnectListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PortConnectListener.operator()(const char*, ConnectorProfile)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortConnectListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
memfunc | 関数オブジェクト |
template <class Listener> PortConnectListener* addPortConnectListener(PortConnectListenerType listener_type, void (Listener::memfunc)(const char, ConnectorProfile&))
OpenRTM_aist.RTObjectBase.RTObjectBase.addPortConnectRetListener | ( | self, | |
listener_type, | |||
memfunc ) |
PortConnectRetListener リスナを追加する
Portの接続時や接続解除時に呼び出される各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PortConnectRetListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PortConnectRetListener.operator()(const char*, ConnectorProfile)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortConnectRetListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
memfunc | 関数オブジェクト |
template <class Listener> PortConnectRetListener* addPortConnectRetListener(PortConnectRetListenerType listener_type, void (Listener::memfunc)(const char, ConnectorProfile&, ReturnCode_t))
OpenRTM_aist.RTObjectBase.RTObjectBase.addPostComponentActionListener | ( | self, | |
listener_type, | |||
memfunc ) |
PostComponentActionListener リスナを追加する
ComponentAction 実装関数の呼び出し直後のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PostComponentActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PostComponentActionListener.operator()(UniqueId ec_id, ReturnCode_t ret)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePostComponentActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
memfunc | 関数オブジェクト |
template <class Listener> PostComponentActionListener* addPostComponentActionListener(PostCompActionListenerType listener_type, void (Listener::*memfunc)(UniqueId ec_id, ReturnCode_t ret))
OpenRTM_aist.RTObjectBase.RTObjectBase.addPostFsmActionListener | ( | self, | |
listener_type, | |||
memfunc ) |
PostFsmActionListener リスナを追加する
FsmAction 実装関数の呼び出し直後のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PostFsmActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PostFsmActionListener.operator()(const char* state, ReturnCode_t ret)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePostFsmActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.addPreComponentActionListener | ( | self, | |
listener_type, | |||
memfunc ) |
PreComponentActionListener リスナを追加する
ComponentAction 実装関数の呼び出し直前のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PreComponentActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PreComponentActionListener.operator()(UniqueId ec_id)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePreComponentActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
memfunc | 関数オブジェクト |
template <class Listener> PreComponentActionListener* addPreComponentActionListener(PreCompActionListenerType listener_type, void (Listener::*memfunc)(UniqueId ec_id))
OpenRTM_aist.RTObjectBase.RTObjectBase.addPreFsmActionListener | ( | self, | |
listener_type, | |||
memfunc ) |
PreFsmActionListener リスナを追加する
FsmAction 実装関数の呼び出し直前のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PreFsmActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PreFsmActionListener.operator()(UniqueId ec_id)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePreFsmActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.addSdoServiceConsumer | ( | self, | |
prof ) |
[local interface] SDO service consumer をセットする
bool addSdoServiceConsumer(const SDOPackage.ServiceProfile& prof);
OpenRTM_aist.RTObjectBase.RTObjectBase.addSdoServiceProvider | ( | self, | |
prof, | |||
provider ) |
[local interface] SDO service provider をセットする
bool addSdoServiceProvider(const SDOPackage.ServiceProfile& prof, SdoServiceProviderBase* provider);
OpenRTM_aist.RTObjectBase.RTObjectBase.attach_context | ( | self, | |
exec_context ) |
[CORBA interface] ExecutionContextをattachする
指定した ExecutionContext にこの RTC を所属させる。この RTC と関連する ExecutionContext のハンドルを返す。 このオペレーションは、ExecutionContextOperations.add_component が呼ばれた 際に呼び出される。返されたハンドルは他のクライアントで使用することを想定 していない。
self | |
exec_context | 所属先 ExecutionContext |
UniqueId attach_context(ExecutionContext_ptr exec_context)
OpenRTM_aist.RTObjectBase.RTObjectBase.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)
OpenRTM_aist.RTObjectBase.RTObjectBase.createContexts | ( | self, | |
ec_args ) |
creating, initializing and binding context
ReturnCode_t createContexts(std.vector<coil.Properties>& ec_args);
OpenRTM_aist.RTObjectBase.RTObjectBase.deactivate | ( | self, | |
ec_id ) |
[local interface] 状態を Inactive に遷移させる
状態を Active から Inactive に遷移させる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数は上記の関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
ReturnCode_t deactivate(RTC.UniqueId ec_id);
OpenRTM_aist.RTObjectBase.RTObjectBase.deletePort | ( | self, | |
port ) |
[local interface] Port の登録を削除する
RTC が保持するPortの登録を削除する。
self | |
port | 削除対象 Port |
void RTObject_impl.deletePort(PortBase& port)
OpenRTM_aist.RTObjectBase.RTObjectBase.deletePortByName | ( | self, | |
port_name ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.detach_context | ( | self, | |
ec_id ) |
[CORBA interface] ExecutionContextをdetachする
指定した ExecutionContext からこの RTC の所属を解除する。 このオペレーションは、ExecutionContextOperations.remove_component が呼ば れた際に呼び出される。返されたハンドルは他のクライアントで使用することを 想定していない。
制約
self | |
ec_id | 解除対象 ExecutionContextハンドル |
ReturnCode_t detach_context(UniqueId exec_handle)
OpenRTM_aist.RTObjectBase.RTObjectBase.exit | ( | self | ) |
[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる
この RTC がオーナーであるすべての実行コンテキストを停止する。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければならない。 RTC が実行中のどの ExecutionContext でも Active 状態ではなくなった後、 この RTC とこれに含まれる RTC が終了する。
制約
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.finalize | ( | self | ) |
[CORBA interface] RTC を終了する
このオペレーション呼び出しの結果として ComponentAction.on_finalize() を呼び出す。
制約
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.finalizePorts | ( | self | ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.findExistingEC | ( | self, | |
ec_arg ) |
fiding existing EC from the factory
ReturnCode_t findExistingEC(coil.Properties& ec_arg, RTC.ExecutionContextBase*& ec);
OpenRTM_aist.RTObjectBase.RTObjectBase.get_component_profile | ( | self | ) |
[RTObject CORBA interface] コンポーネントプロファイルを取得する
当該コンポーネントのプロファイル情報を返す。
self |
virtual ComponentProfile* get_component_profile()
OpenRTM_aist.RTObjectBase.RTObjectBase.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()
OpenRTM_aist.RTObjectBase.RTObjectBase.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)
OpenRTM_aist.RTObjectBase.RTObjectBase.get_context_handle | ( | self, | |
cxt ) |
[CORBA interface] ExecutionContext のハンドルを返す
ExecutionContext | 実行コンテキスト |
与えられた実行コンテキストに関連付けられたハンドルを返す。
virtual ExecutionContextHandle_t get_context_handle(ExecutionContext_ptr cxt)
OpenRTM_aist.RTObjectBase.RTObjectBase.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()
OpenRTM_aist.RTObjectBase.RTObjectBase.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()
OpenRTM_aist.RTObjectBase.RTObjectBase.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() |
OpenRTM_aist.RTObjectBase.RTObjectBase.get_owned_contexts | ( | self | ) |
[CORBA interface] 所有する ExecutionContextListを 取得する
この RTC が所有する ExecutionContext のリストを取得する。
virtual ExecutionContextList* get_owned_contexts()
OpenRTM_aist.RTObjectBase.RTObjectBase.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()
OpenRTM_aist.RTObjectBase.RTObjectBase.get_participating_contexts | ( | self | ) |
[CORBA interface] 参加している ExecutionContextList を取得する
この RTC が参加している ExecutionContext のリストを取得する。
virtual ExecutionContextList* get_participating_contexts()
OpenRTM_aist.RTObjectBase.RTObjectBase.get_ports | ( | self | ) |
[RTObject CORBA interface] ポートを取得する
当該コンポーネントが保有するポートの参照を返す。
self |
virtual PortServiceList* get_ports()
OpenRTM_aist.RTObjectBase.RTObjectBase.get_sdo_id | ( | self | ) |
SDO ID を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
virtual char* get_sdo_id()
OpenRTM_aist.RTObjectBase.RTObjectBase.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)
OpenRTM_aist.RTObjectBase.RTObjectBase.get_sdo_type | ( | self | ) |
SDO Type を返すオペレーション。 このオペレーションは以下の型の例外を発生させる。
self |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
virtual char* get_sdo_type()
OpenRTM_aist.RTObjectBase.RTObjectBase.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)
OpenRTM_aist.RTObjectBase.RTObjectBase.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()
OpenRTM_aist.RTObjectBase.RTObjectBase.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) |
OpenRTM_aist.RTObjectBase.RTObjectBase.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()
OpenRTM_aist.RTObjectBase.RTObjectBase.getCategory | ( | self | ) |
[local interface] カテゴリ情報の取得
ComponentProfile に設定されたカテゴリ情報を返す。
self |
const char* getCategory()
OpenRTM_aist.RTObjectBase.RTObjectBase.getConfigService | ( | self | ) |
コンフィギュレーションサービスを取得する
コンフィギュレーションサービスオブジェクトを取得する。このサービ スオブジェクトを利用して、コンフィギュレーションパラメータの操作 を行うことができる。主な操作としては、
コールバック関連
詳細はConfigAdminクラスリファレンスを参照のこと。
ConfigAdmin& getConfigService() { return m_configsets; }
OpenRTM_aist.RTObjectBase.RTObjectBase.getContextOptions | ( | self, | |
ec_args ) |
getting EC options
ReturnCode_t getContextOptions(std.vector<coil.Properties>& ec_args);
OpenRTM_aist.RTObjectBase.RTObjectBase.getDescription | ( | self | ) |
[local interface] Description の取得
ComponentProfile に設定された Description を返す。
self |
const char* getDescription()
OpenRTM_aist.RTObjectBase.RTObjectBase.getExecutionContext | ( | self, | |
ec_id ) |
[local interface] 実行コンテキストを取得する
get_context() と同じ機能のローカル版。違いはない。 この関数は以下の関数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
ExecutionContext_ptr getExecutionContext(RTC.UniqueId ec_id);
OpenRTM_aist.RTObjectBase.RTObjectBase.getExecutionRate | ( | self, | |
ec_id ) |
[local interface] 実行コンテキストの実行レートを取得する
現在実行中の実行コンテキストの実行レートを取得する。実行コンテキ ストのKindがPERIODIC以外の場合の動作は未定義である。この関数は以 下の関数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
double getExecutionRate(RTC.UniqueId ec_id);
OpenRTM_aist.RTObjectBase.RTObjectBase.getGlobalContextOptions | ( | self, | |
global_ec_props ) |
getting global EC options from rtc.conf
ReturnCode_t getGlobalContextOptions(coil.Properties& global_ec_props);
OpenRTM_aist.RTObjectBase.RTObjectBase.getInstanceName | ( | self | ) |
[local interface] インスタンス名の取得
ComponentProfile に設定されたインスタンス名を返す。
self |
const char* getInstanceName()
OpenRTM_aist.RTObjectBase.RTObjectBase.getNamingNames | ( | self | ) |
[local interface] Naming Server 情報の取得
設定された Naming Server 情報を返す。
self |
std.vector<std.string> getNamingNames();
OpenRTM_aist.RTObjectBase.RTObjectBase.getObjRef | ( | self | ) |
[local interface] オブジェクトリファレンスの取得
設定された CORBA オブジェクトリファレンスを取得する。
self |
RTObject_ptr getObjRef() const;
OpenRTM_aist.RTObjectBase.RTObjectBase.getPrivateContextOptions | ( | self, | |
ec_args ) |
getting individual EC options from RTC's configuration file
ReturnCode_t getPrivateContextOptions(std.vector<coil.Properties>& ec_args);
OpenRTM_aist.RTObjectBase.RTObjectBase.getProperties | ( | self | ) |
[local interface] RTC のプロパティを取得する
RTC が保持しているプロパティを返す。 RTCがプロパティを持たない場合は空のプロパティが返される。
self |
coil.Properties& getProperties();
OpenRTM_aist.RTObjectBase.RTObjectBase.getTypeName | ( | self | ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.getVendor | ( | self | ) |
[local interface] ベンダー情報の取得
ComponentProfile に設定されたベンダー情報を返す。
self |
const char* getVendor()
OpenRTM_aist.RTObjectBase.RTObjectBase.getVersion | ( | self | ) |
[local interface] バージョン情報の取得
ComponentProfile に設定されたバージョン情報を返す。
self |
const char* getVersion()
OpenRTM_aist.RTObjectBase.RTObjectBase.initialize | ( | self | ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.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)
OpenRTM_aist.RTObjectBase.RTObjectBase.isOwnExecutionContext | ( | self, | |
ec_id ) |
[local interface] 実行コンテキストの所有権を調べる
現在実行中の実行コンテキストの所有権を調べる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
bool isOwnExecutionContext(RTC.UniqueId ec_id);
OpenRTM_aist.RTObjectBase.RTObjectBase.on_aborting | ( | self, | |
ec_id ) |
[ComponentAction CORBA interface] RTC のエラー状態への遷移
RTC が所属する ExecutionContext が Active 状態から Error 状態へ遷移した 場合に呼び出される。 このオペレーションは RTC が Error 状態に遷移した際に一度だけ呼び出される。 このオペレーション呼び出しの結果として onAborting() コールバック関数が 呼び出される。
self | |
ec_id | 状態遷移した ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_activated | ( | self, | |
ec_id ) |
[ComponentAction CORBA interface] RTC の活性化
所属する ExecutionContext から RTC が活性化された際に呼び出される。 このオペレーション呼び出しの結果として onActivated() コールバック関数が 呼び出される。
self | |
ec_id | 活性化 ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_deactivated | ( | self, | |
ec_id ) |
[ComponentAction CORBA interface] RTC の非活性化
所属する ExecutionContext から RTC が非活性化された際に呼び出される。 このオペレーション呼び出しの結果として onDeactivated() コールバック関数が 呼び出される。
self | |
ec_id | 非活性化 ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_error | ( | self, | |
ec_id ) |
[ComponentAction CORBA interface] RTC のエラー処理
RTC がエラー状態にいる際に呼び出される。 RTC がエラー状態の場合に、対象となる ExecutionContext のExecutionKind に 応じたタイミングで呼び出される。例えば、
self | |
ec_id | 対象 ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_finalize | ( | self | ) |
[ComponentAction CORBA interface] RTC の終了
RTC が破棄される。 RTC 固有の終了処理はここで実行する。 このオペレーション呼び出しの結果として onFinalize() コールバック関数が 呼び出される。
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_initialize | ( | self | ) |
[ComponentAction CORBA interface] RTC の初期化
RTC が初期化され、Alive 状態に遷移する。 RTC 固有の初期化処理はここで実行する。 このオペレーション呼び出しの結果として onInitialize() コールバック関数が 呼び出される。
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_reset | ( | self, | |
ec_id ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_shutdown | ( | self, | |
ec_id ) |
[ComponentAction CORBA interface] RTC の停止
RTC が所属する ExecutionContext が Running 状態から Stopped 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onShutdown() コールバック関数が 呼び出される。
self | |
ec_id | 状態遷移した ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.on_startup | ( | self, | |
ec_id ) |
[ComponentAction CORBA interface] RTC の開始
RTC が所属する ExecutionContext が Stopped 状態から Running 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onStartup() コールバック関数が 呼び出される。
self | |
ec_id | 状態遷移した ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onAborting | ( | self, | |
ec_id ) |
中断処理用コールバック関数
ComponentAction.on_aborting が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の中断処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onAction | ( | self, | |
ec_id ) |
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onActivated | ( | self, | |
ec_id ) |
活性化処理用コールバック関数
ComponentAction.on_activated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の活性化処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onDeactivated | ( | self, | |
ec_id ) |
非活性化処理用コールバック関数
ComponentAction.on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の非活性化処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onError | ( | self, | |
ec_id ) |
エラー処理用コールバック関数
ComponentAction.on_error が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のエラー処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onExecute | ( | self, | |
ec_id ) |
周期処理用コールバック関数
DataFlowComponentAction.on_execute が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の周期処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 1回目の実行パスとして定期的に呼び出される。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onFinalize | ( | self | ) |
終了処理用コールバック関数
ComponentAction.on_finalize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の終了処理は、本関数をオーバーライドして実装する 必要がある。
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.onInitialize | ( | self | ) |
初期化処理用コールバック関数
ComponentAction.on_initialize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の初期化処理は、本関数をオーバーライドして実装する 必要がある。
self |
OpenRTM_aist.RTObjectBase.RTObjectBase.onRateChanged | ( | self, | |
ec_id ) |
動作周期変更通知用コールバック関数
DataFlowComponentAction.on_rate_changed が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing において ExecutionContext の 実行が更新された際に呼び出される。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onReset | ( | self, | |
ec_id ) |
リセット処理用コールバック関数
ComponentAction.on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onShutdown | ( | self, | |
ec_id ) |
停止処理用コールバック関数
ComponentAction.on_shutdown が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の停止処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onStartup | ( | self, | |
ec_id ) |
開始処理用コールバック関数
ComponentAction.on_startup が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の開始処理は、本関数をオーバーライドして実装する 必要がある。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.onStateUpdate | ( | self, | |
ec_id ) |
状態変更処理用コールバック関数
DataFlowComponentAction.on_state_update が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC.RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 2回目の実行パスとして定期的に呼び出される。
self | |
ec_id | 参加している ExecutionContext の ID |
OpenRTM_aist.RTObjectBase.RTObjectBase.readAll | ( | self | ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.registerInPort | ( | self, | |
name, | |||
inport ) |
[local interface] DataInPort を登録する
RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。
self | |
name | port 名称 |
inport | 登録対象 DataInPort |
OpenRTM_aist.RTObjectBase.RTObjectBase.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);
OpenRTM_aist.RTObjectBase.RTObjectBase.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);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeConfigurationParamListener | ( | self, | |
type, | |||
listener ) |
ConfigurationParamListener を削除する
addConfigurationParamListener で追加されたリスナオブジェクトを削除する。
type | ConfigurationParamListenerType型の値。 ON_UPDATE_CONFIG_PARAM がある。 |
listener | 与えたリスナオブジェクトへのポインタ |
void removeConfigurationParamListener(ConfigurationParamListenerType type, ConfigurationParamListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeConfigurationSetListener | ( | self, | |
type, | |||
listener ) |
ConfigurationSetListener を削除する
addConfigurationSetListener で追加されたリスナオブジェクトを削除する。
type | ConfigurationSetListenerType型の値。 |
listener | 与えたリスナオブジェクトへのポインタ |
void removeConfigurationSetListener(ConfigurationSetListenerType type, ConfigurationSetListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeConfigurationSetNameListener | ( | self, | |
type, | |||
listener ) |
ConfigurationSetNameListener を削除する
addConfigurationSetNameListener で追加されたリスナオブジェクトを 削除する。
type | ConfigurationSetNameListenerType型の値。 ON_UPDATE_CONFIG_PARAM がある。 |
listener | 与えたリスナオブジェクトへのポインタ |
void removeConfigurationSetNameListener(ConfigurationSetNameListenerType type, ConfigurationSetNameListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeExecutionContextActionListener | ( | self, | |
listener_type, | |||
listener ) |
ExecutionContextActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removeExecutionContextActionListener(ECActionListenerType listener_type, ECActionListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeFsmProfileListener | ( | self, | |
listener_type, | |||
listener ) |
FsmProfileListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.removeFsmStructureListener | ( | self, | |
listener_type, | |||
listener ) |
FsmStructureListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.removeInPort | ( | self, | |
port ) |
[local interface] InPort の登録を削除する
RTC が保持するInPortの登録を削除する。
port | 削除対象 Port |
bool removeInPort(InPortBase& port);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeOutPort | ( | self, | |
port ) |
[local interface] OutPort の登録を削除する
RTC が保持するOutPortの登録を削除する。
port | 削除対象 Port |
bool removeOutPort(OutPortBase& port);
OpenRTM_aist.RTObjectBase.RTObjectBase.removePortActionListener | ( | self, | |
listener_type, | |||
listener ) |
PortActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removePortActionListener(PortActionListenerType listener_type, PortActionListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removePortConnectListener | ( | self, | |
listener_type, | |||
listener ) |
PortConnectListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removePortConnectListener(PortConnectListenerType listener_type, PortConnectListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removePortConnectRetListener | ( | self, | |
listener_type, | |||
listener ) |
PortConnectRetListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removePortConnectRetListener(PortConnectRetListenerType listener_type, PortConnectRetListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removePostComponentActionListener | ( | self, | |
listener_type, | |||
listener ) |
PostComponentActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removePostComponentActionListener(PostComponentActionListenerType listener_type, PostComponentActionListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removePostFsmActionListener | ( | self, | |
listener_type, | |||
listener ) |
PostFsmActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.removePreComponentActionListener | ( | self, | |
listener_type, | |||
listener ) |
PreComponentActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void removePreComponentActionListener(PreComponentActionListenerType listener_type, PreComponentActionListener* listener);
OpenRTM_aist.RTObjectBase.RTObjectBase.removePreFsmActionListener | ( | self, | |
listener_type, | |||
listener ) |
PreFsmActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
OpenRTM_aist.RTObjectBase.RTObjectBase.removeSdoServiceConsumer | ( | self, | |
id ) |
[local interface] SDO service consumer を削除する
bool removeSdoServiceConsumer(const char* id);
OpenRTM_aist.RTObjectBase.RTObjectBase.removeSdoServiceProvider | ( | self, | |
id ) |
[local interface] SDO service provider を削除する
bool removeSdoServiceProvider(const char* id);
OpenRTM_aist.RTObjectBase.RTObjectBase.reset | ( | self, | |
ec_id ) |
[local interface] 状態をリセットし Inactive に遷移させる
状態を Error から Inactive に遷移させる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数は上記の関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
ReturnCode_t reset(RTC.UniqueId ec_id);
OpenRTM_aist.RTObjectBase.RTObjectBase.setExecutionRate | ( | self, | |
ec_id, | |||
rate ) |
[local interface] 実行コンテキストの実行レートを設定する
現在実行中の実行コンテキストの実行レートを設定する。実行コンテキ ストのKindがPERIODIC以外の場合の動作は未定義である。この関数は以 下の関数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
rate | 実行レートを [Hz] で与える |
ReturnCode_t setExecutionRate(RTC.UniqueId ec_id, double rate);
OpenRTM_aist.RTObjectBase.RTObjectBase.setInstanceName | ( | self, | |
instance_name ) |
[local interface] インスタンス名の設定
ComponentProfile に指定されたインスタンス名を設定する。
self | |
instance_name | インスタンス名 |
void setInstanceName(const char* instance_name);
OpenRTM_aist.RTObjectBase.RTObjectBase.setObjRef | ( | self, | |
rtobj ) |
[local interface] オブジェクトリファレンスの設定
RTC の CORBA オブジェクトリファレンスを設定する。
self | |
rtobj | オブジェクトリファレンス |
void setObjRef(const RTObject_ptr rtobj);
OpenRTM_aist.RTObjectBase.RTObjectBase.setProperties | ( | self, | |
prop ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.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);
OpenRTM_aist.RTObjectBase.RTObjectBase.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);
OpenRTM_aist.RTObjectBase.RTObjectBase.shutdown | ( | self | ) |
OpenRTM_aist.RTObjectBase.RTObjectBase.updateParameters | ( | self, | |
config_set ) |
コンフィギュレーションパラメータの更新(ID指定)
指定したIDのコンフィギュレーションセットに設定した値で、 コンフィギュレーションパラメータの値を更新する
self | |
config_set | 設定対象のコンフィギュレーションセットID |
void updateParameters(const char* config_set);
OpenRTM_aist.RTObjectBase.RTObjectBase.writeAll | ( | self | ) |
全 OutPort のwrite()メソッドをコールする。
RTC が保持する全ての OutPort のwrite()メソッドをコールする。
bool writeAll();