OpenRTM-aist 2.0.2
|
RTコンポーネントクラス [詳解]
#include <RTObject.h>
クラス | |
struct | deactivate_comps |
RTC 非活性化用ファンクタ [詳解] | |
struct | ec_copy |
ExecutionContext コピーファンクタ [詳解] | |
struct | ec_find |
ExecutionContext 検索用ファンクタ [詳解] | |
struct | nv_name |
NVList 検索用ファンクタ [詳解] | |
class | SdoServiceConsumerTerminator |
struct | svc_name |
SDOService のプロファイルリストからidでサーチするためのファンクタ [詳解] | |
公開メンバ関数 | |
RTObject_impl (Manager *manager) | |
コンストラクタ | |
RTObject_impl (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa) | |
コンストラクタ | |
~RTObject_impl () override | |
仮想デストラクタ | |
ReturnCode_t | initialize () override |
[CORBA interface] RTCを初期化する | |
ReturnCode_t | finalize () override |
[CORBA interface] RTC を終了する | |
ReturnCode_t | exit () override |
[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる | |
CORBA::Boolean | is_alive (ExecutionContext_ptr exec_context) override |
[CORBA interface] RTC が Alive 状態であるかどうか確認する。 | |
ExecutionContext_ptr | get_context (UniqueId ec_id) override |
[CORBA interface] ExecutionContextを取得する | |
ExecutionContextList * | get_owned_contexts () override |
[CORBA interface] 所有する ExecutionContextListを 取得する | |
ExecutionContextList * | get_participating_contexts () override |
[CORBA interface] 参加している ExecutionContextList を取得する | |
ExecutionContextHandle_t | get_context_handle (ExecutionContext_ptr cxt) override |
[CORBA interface] ExecutionContext のハンドルを返す | |
UniqueId | attach_context (ExecutionContext_ptr exec_context) override |
[CORBA interface] ExecutionContextをattachする | |
UniqueId | bindContext (ExecutionContext_ptr exec_context) |
ReturnCode_t | detach_context (UniqueId ec_id) override |
[CORBA interface] ExecutionContextをdetachする | |
ComponentProfile * | get_component_profile () override |
[RTObject CORBA interface] コンポーネントプロファイルを取得する | |
PortServiceList * | get_ports () override |
[RTObject CORBA interface] ポートを取得する | |
ReturnCode_t | on_initialize () override |
[ComponentAction CORBA interface] RTC の初期化 | |
ReturnCode_t | on_finalize () override |
[ComponentAction CORBA interface] RTC の終了 | |
ReturnCode_t | on_startup (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC の開始 | |
ReturnCode_t | on_shutdown (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC の停止 | |
ReturnCode_t | on_activated (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC の活性化 | |
ReturnCode_t | on_deactivated (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC の非活性化 | |
ReturnCode_t | on_aborting (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC のエラー状態への遷移 | |
ReturnCode_t | on_error (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC のエラー処理 | |
ReturnCode_t | on_reset (UniqueId ec_id) override |
[ComponentAction CORBA interface] RTC のリセット | |
ReturnCode_t | on_execute (UniqueId ec_id) override |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期) | |
ReturnCode_t | on_state_update (UniqueId ec_id) override |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期) | |
ReturnCode_t | on_rate_changed (UniqueId ec_id) override |
[DataFlowComponentAction CORBA interface] 実行周期変更通知 | |
SDOPackage::OrganizationList * | get_owned_organizations () override |
[SDO interface] Organization リストの取得 | |
char * | get_sdo_id () override |
[SDO interface] SDO ID の取得 | |
char * | get_sdo_type () override |
[SDO interface] SDO タイプの取得 | |
SDOPackage::DeviceProfile * | get_device_profile () override |
[SDO interface] SDO DeviceProfile リストの取得 | |
SDOPackage::ServiceProfileList * | get_service_profiles () override |
[SDO interface] SDO ServiceProfile の取得 | |
SDOPackage::ServiceProfile * | get_service_profile (const char *id) override |
[SDO interface] 特定のServiceProfileの取得 | |
SDOPackage::SDOService_ptr | get_sdo_service (const char *id) override |
[SDO interface] 指定された SDO Service の取得 | |
SDOPackage::Configuration_ptr | get_configuration () override |
[SDO interface] Configuration オブジェクトの取得 | |
SDOPackage::Monitoring_ptr | get_monitoring () override |
[SDO interface] Monitoring オブジェクトの取得 | |
SDOPackage::OrganizationList * | get_organizations () override |
[SDO interface] Organization リストの取得 | |
SDOPackage::NVList * | get_status_list () override |
[SDO interface] SDO Status リストの取得 | |
CORBA::Any * | get_status (const char *name) override |
[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 (RTObject_ptr rtobj) |
[local interface] オブジェクトリファレンスの設定 | |
RTObject_ptr | getObjRef () const |
[local interface] オブジェクトリファレンスの取得 | |
void | setProperties (const coil::Properties &prop) |
[local interface] RTC のプロパティを設定する | |
coil::Properties & | getProperties () |
[local interface] RTC のプロパティを取得する | |
template<typename VarType > | |
bool | bindParameter (const char *param_name, VarType &var, const char *def_val, bool(*trans)(VarType &, const char *)=coil::stringTo) |
コンフィギュレーションパラメータの設定 | |
ConfigAdmin & | getConfigService () |
コンフィギュレーションサービスを取得する | |
void | updateParameters (const char *config_set) |
コンフィギュレーションパラメータの更新(ID指定) | |
bool | addPort (PortBase &port) |
[local interface] Port を登録する | |
bool | addPort (PortService_ptr port) |
[local interface] Port を登録する | |
bool | addPort (CorbaPort &port) |
[local interface] Port を登録する | |
void | registerPort (PortBase &port) |
[local interface] Port を登録する | |
void | registerPort (PortService_ptr port) |
[local interface] Port を登録する | |
void | registerPort (CorbaPort &port) |
[local interface] Port を登録する | |
bool | addInPort (const char *name, InPortBase &inport) |
[local interface] DataInPort を登録する | |
const std::vector< InPortBase * > & | getInPorts () const |
const std::vector< OutPortBase * > & | getOutPorts () const |
void | registerInPort (const char *name, InPortBase &inport) |
[local interface] DataInPort を登録する | |
bool | addOutPort (const char *name, OutPortBase &outport) |
[local interface] DataOutPort を登録する | |
void | registerOutPort (const char *name, OutPortBase &outport) |
[local interface] DataOutPort を登録する | |
bool | removeInPort (InPortBase &inport) |
[local interface] InPort の登録を削除する | |
bool | removeOutPort (OutPortBase &outport) |
[local interface] OutPort の登録を削除する | |
bool | removePort (PortBase &port) |
[local interface] Port の登録を削除する | |
bool | removePort (PortService_ptr port) |
[local interface] Port の登録を削除する | |
bool | removePort (CorbaPort &port) |
[local interface] Port の登録を削除する | |
void | deletePort (PortBase &port) |
[local interface] Port の登録を削除する | |
void | deletePort (PortService_ptr port) |
[local interface] Port の登録を削除する | |
void | deletePort (CorbaPort &port) |
[local interface] Port の登録を削除する | |
void | deletePortByName (const char *port_name) |
[local interface] 名前指定により Port の登録を削除する | |
ExecutionContext_ptr | getExecutionContext (RTC::UniqueId ec_id) |
[local interface] 実行コンテキストを取得する | |
double | getExecutionRate (RTC::UniqueId ec_id) |
[local interface] 実行コンテキストの実行レートを取得する | |
ReturnCode_t | setExecutionRate (RTC::UniqueId ec_id, double rate) |
[local interface] 実行コンテキストの実行レートを設定する | |
ReturnCode_t | deactivate (RTC::UniqueId ec_id) |
[local interface] 状態を Inactive に遷移させる | |
ReturnCode_t | activate (RTC::UniqueId ec_id) |
[local interface] 状態を Active に遷移させる | |
ReturnCode_t | reset (RTC::UniqueId ec_id) |
[local interface] 状態をリセットし Inactive に遷移させる | |
bool | addSdoServiceProvider (const SDOPackage::ServiceProfile &prof, SdoServiceProviderBase *provider) |
[local interface] SDO service provider をセットする | |
bool | removeSdoServiceProvider (const char *id) |
[local interface] SDO service provider を削除する | |
bool | addSdoServiceConsumer (const SDOPackage::ServiceProfile &prof) |
[local interface] SDO service provider をセットする | |
bool | removeSdoServiceConsumer (const char *id) |
[local interface] SDO service provider を削除する | |
void | removeSdoServiceConsumerStartThread (const char *id) |
[local interface] SDO service provider を別スレッドで削除する | |
bool | readAll () |
全 InPort のデータを読み込む。 | |
bool | writeAll () |
全 OutPort のwrite()メソッドをコールする。 | |
void | setReadAll (bool read=true, bool completion=false) |
onExecute()実行前でのreadAll()メソッドの呼出を有効または無効にする。 | |
void | setWriteAll (bool write=true, bool completion=false) |
onExecute()実行後にwriteAll()メソッドの呼出を有効または無効にする。 | |
void | finalizePorts () |
全 Port の登録を削除する | |
void | finalizeContexts () |
ExecutionContextBaseリストの登録を削除する | |
void | setINSObjRef (RTC::LightweightRTObject_ptr obj) |
omniINSPOAから取得したオブジェクトを登録 | |
void | addPreComponentActionListener (PreCompActionListenerType listener_type, PreCompActionListener *listener, bool autoclean=true) |
template<class Listener > | |
PreComponentActionListener * | addPreComponentActionListener (PreCompActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(UniqueId ec_id)) |
void | removePreComponentActionListener (PreComponentActionListenerType listener_type, PreComponentActionListener *listener) |
PreComponentActionListener リスナを削除する | |
void | addPostComponentActionListener (PostComponentActionListenerType listener_type, PostComponentActionListener *listener, bool autoclean=true) |
template<class Listener > | |
PostComponentActionListener * | addPostComponentActionListener (PostCompActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(UniqueId ec_id, ReturnCode_t ret)) |
void | removePostComponentActionListener (PostComponentActionListenerType listener_type, PostComponentActionListener *listener) |
PostComponentActionListener リスナを削除する | |
void | addPortActionListener (PortActionListenerType listener_type, PortActionListener *listener, bool autoclean=true) |
PortActionListener リスナを追加する | |
template<class Listener > | |
PortActionListener * | addPortActionListener (PortActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const RTC::PortProfile &)) |
void | removePortActionListener (PortActionListenerType listener_type, PortActionListener *listener) |
PortActionListener リスナを削除する | |
void | addExecutionContextActionListener (ECActionListenerType listener_type, ECActionListener *listener, bool autoclean=true) |
template<class Listener > | |
ECActionListener * | addExecutionContextActionListener (ECActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(UniqueId)) |
void | removeExecutionContextActionListener (ECActionListenerType listener_type, ECActionListener *listener) |
ExecutionContextActionListener リスナを削除する | |
void | addPortConnectListener (PortConnectListenerType listener_type, PortConnectListener *listener, bool autoclean=true) |
PortConnectListener リスナを追加する | |
template<class Listener > | |
PortConnectListener * | addPortConnectListener (PortConnectListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *, ConnectorProfile &)) |
void | removePortConnectListener (PortConnectListenerType listener_type, PortConnectListener *listener) |
PortConnectListener リスナを削除する | |
void | addPortConnectRetListener (PortConnectRetListenerType listener_type, PortConnectRetListener *listener, bool autoclean=true) |
PortConnectRetListener リスナを追加する | |
template<class Listener > | |
PortConnectRetListener * | addPortConnectRetListener (PortConnectRetListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *, ConnectorProfile &, ReturnCode_t)) |
void | removePortConnectRetListener (PortConnectRetListenerType listener_type, PortConnectRetListener *listener) |
PortConnectRetListener リスナを削除する | |
void | addConfigurationParamListener (ConfigurationParamListenerType type, ConfigurationParamListener *listener, bool autoclean=true) |
ConfigurationParamListener を追加する | |
template<class Listener > | |
ConfigurationParamListener * | addConfigurationParamListener (ConfigurationParamListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *, const char *)) |
void | removeConfigurationParamListener (ConfigurationParamListenerType type, ConfigurationParamListener *listener) |
ConfigurationParamListener を削除する | |
void | addConfigurationSetListener (ConfigurationSetListenerType type, ConfigurationSetListener *listener, bool autoclean=true) |
ConfigurationSetListener を追加する | |
template<class Listener > | |
ConfigurationSetListener * | addConfigurationSetListener (ConfigurationSetListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const coil::Properties &config_set)) |
void | removeConfigurationSetListener (ConfigurationSetListenerType type, ConfigurationSetListener *listener) |
ConfigurationSetListener を削除する | |
void | addConfigurationSetNameListener (ConfigurationSetNameListenerType type, ConfigurationSetNameListener *listener, bool autoclean=true) |
ConfigurationSetNameListener を追加する | |
template<class Listener > | |
ConfigurationSetNameListener * | addConfigurationSetNameListener (ConfigurationSetNameListenerType type, Listener &obj, void(Listener::*memfunc)(const char *)) |
void | removeConfigurationSetNameListener (ConfigurationSetNameListenerType type, ConfigurationSetNameListener *listener) |
ConfigurationSetNameListener を削除する | |
void | addPreFsmActionListener (PreFsmActionListenerType listener_type, PreFsmActionListener *listener, bool autoclean=true) |
PreFsmActionListener リスナを追加する | |
template<class Listener > | |
PreFsmActionListener * | addPreFsmActionListener (PreFsmActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *state)) |
void | removePreFsmActionListener (PreFsmActionListenerType listener_type, PreFsmActionListener *listener) |
PreFsmActionListener リスナを削除する | |
void | addPostFsmActionListener (PostFsmActionListenerType listener_type, PostFsmActionListener *listener, bool autoclean=true) |
PostFsmActionListener リスナを追加する | |
template<class Listener > | |
PostFsmActionListener * | addPostFsmActionListener (PostFsmActionListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const char *state, ReturnCode_t ret)) |
void | removePostFsmActionListener (PostFsmActionListenerType listener_type, PostFsmActionListener *listener) |
PostFsmActionListener リスナを削除する | |
void | addFsmProfileListener (FsmProfileListenerType listener_type, FsmProfileListener *listener, bool autoclean=true) |
FsmProfileListener リスナを追加する | |
template<class Listener > | |
FsmProfileListener * | addFsmProfileListener (FsmProfileListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const RTC::PortProfile &)) |
void | removeFsmProfileListener (FsmProfileListenerType listener_type, FsmProfileListener *listener) |
FsmProfileListener リスナを削除する | |
void | addFsmStructureListener (FsmStructureListenerType listener_type, FsmStructureListener *listener, bool autoclean=true) |
FsmStructureListener リスナを追加する | |
template<class Listener > | |
FsmStructureListener * | addFsmStructureListener (FsmStructureListenerType listener_type, Listener &obj, void(Listener::*memfunc)(const RTC::PortProfile &)) |
void | removeFsmStructureListener (FsmStructureListenerType listener_type, FsmStructureListener *listener) |
FsmStructureListener リスナを削除する | |
void | preOnInitialize (UniqueId ec_id) |
void | preOnFinalize (UniqueId ec_id) |
void | preOnStartup (UniqueId ec_id) |
void | preOnShutdown (UniqueId ec_id) |
void | preOnActivated (UniqueId ec_id) |
void | preOnDeactivated (UniqueId ec_id) |
void | preOnAborting (UniqueId ec_id) |
void | preOnError (UniqueId ec_id) |
void | preOnReset (UniqueId ec_id) |
void | preOnExecute (UniqueId ec_id) |
void | preOnStateUpdate (UniqueId ec_id) |
void | preOnRateChanged (UniqueId ec_id) |
void | postOnInitialize (UniqueId ec_id, ReturnCode_t ret) |
void | postOnFinalize (UniqueId ec_id, ReturnCode_t ret) |
void | postOnStartup (UniqueId ec_id, ReturnCode_t ret) |
void | postOnShutdown (UniqueId ec_id, ReturnCode_t ret) |
void | postOnActivated (UniqueId ec_id, ReturnCode_t ret) |
void | postOnDeactivated (UniqueId ec_id, ReturnCode_t ret) |
void | postOnAborting (UniqueId ec_id, ReturnCode_t ret) |
void | postOnError (UniqueId ec_id, ReturnCode_t ret) |
void | postOnReset (UniqueId ec_id, ReturnCode_t ret) |
void | postOnExecute (UniqueId ec_id, ReturnCode_t ret) |
void | postOnStateUpdate (UniqueId ec_id, ReturnCode_t ret) |
void | postOnRateChanged (UniqueId ec_id, ReturnCode_t ret) |
void | onAddPort (const PortProfile &pprof) |
void | onRemovePort (const PortProfile &pprof) |
void | onAttachExecutionContext (UniqueId ec_id) |
void | onDetachExecutionContext (UniqueId ec_id) |
void | preOnFsmInit (const char *state) |
void | preOnFsmEntry (const char *state) |
void | preOnFsmDo (const char *state) |
void | preOnFsmExit (const char *state) |
void | preOnFsmStateChange (const char *state) |
void | postOnFsmInit (const char *state, ReturnCode_t ret) |
void | postOnFsmEntry (const char *state, ReturnCode_t ret) |
void | postOnFsmDo (const char *state, ReturnCode_t ret) |
void | postOnFsmExit (const char *state, ReturnCode_t ret) |
void | postOnFsmStateChange (const char *state, ReturnCode_t ret) |
静的公開メンバ関数 | |
static bool | isOwnExecutionContext (RTC::UniqueId ec_id) |
[local interface] 実行コンテキストの所有権を調べる | |
限定公開メンバ関数 | |
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 を終了する RTC の終了処理を実行する。 保持している全 Port の登録を解除するとともに、該当する CORBA オブジェクト を非活性化し、RTC を終了する。finalize() でのみコールされる。 | |
ReturnCode_t | initMineEC () |
Initialize my EC This function initializes mine ECs. This is called from only initialize(). | |
void | startMineEC () |
Starting my EC This function start mine ECs. This is called from only initialize(). | |
void | finalizeMineEC () |
Finalize my EC This function finalize mine ECs. This is called from only exit(). | |
void | finalizeOtherEC () |
Finalize my EC This function detaching the RTC from others' ECs. This is called from only exit(). | |
ReturnCode_t | getInheritedECOptions (coil::Properties &default_opts) |
Get inherited EC options This function getting inherited EC options. This is called from only initMineEC(). | |
ReturnCode_t | getPrivateContextOptions (std::vector< coil::Properties > &ec_args) |
getting individual EC options from RTC's configuration file | |
ReturnCode_t | getGlobalContextOptions (coil::Properties &global_ec_props) |
getting global EC options from rtc.conf | |
ReturnCode_t | getContextOptions (std::vector< coil::Properties > &ec_args) |
getting EC options | |
ReturnCode_t | createContexts (std::vector< coil::Properties > &ec_args) |
creating, initializing and binding context | |
void | initSdoService () |
initialize SDO service stuff This function calles SdoService's initialize(). | |
静的限定公開メンバ関数 | |
static ReturnCode_t | findExistingEC (coil::Properties &ec_arg, RTC::ExecutionContextBase *&ec) |
fiding existing EC from the factory | |
限定公開変数類 | |
Logger | rtclog |
ロガーストリーム | |
Manager * | m_pManager |
マネージャオブジェクト | |
CORBA::ORB_var | m_pORB |
ORB へのポインタ | |
PortableServer::POA_var | m_pPOA |
POA へのポインタ | |
SDOPackage::OrganizationList | m_sdoOwnedOrganizations |
SDO が保持する organization のリスト | |
SDOPackage::Configuration_impl * | m_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_var | m_objref |
オブジェクトリファレンス | |
PortAdmin | m_portAdmin |
Port のオブジェクトリファレンスのリスト | |
std::vector< InPortBase * > | m_inports |
InPortBase* のリスト | |
std::vector< OutPortBase * > | m_outports |
OutPortBase* のリスト | |
ExecutionContextServiceList | m_ecMine |
自分がownerのExecutionContextService のリスト | |
std::vector< ExecutionContextBase * > | m_eclist |
ExecutionContextBase のリスト | |
ExecutionContextServiceList | m_ecOther |
参加しているExecutionContextService のリスト | |
bool | m_created |
Created 状態フラグ | |
bool | m_exiting |
RTCの終了状態フラグ | |
coil::Properties | m_properties |
RTC のプロパティ | |
ConfigAdmin | m_configsets |
コンフィギュレーション情報管理オブジェクト | |
SdoServiceAdmin | m_sdoservice |
SDO Service 管理オブジェクト | |
bool | m_readAll |
readAll()呼出用のフラグ | |
bool | m_writeAll |
writeAll()呼出用のフラグ | |
bool | m_readAllCompletion |
readAll()用のフラグ | |
bool | m_writeAllCompletion |
writeAll()用のフラグ | |
ComponentActionListeners | m_actionListeners |
ComponentActionListenerホルダ | |
PortConnectListeners | m_portconnListeners |
PortConnectListenerホルダ | |
FsmActionListeners | m_fsmActionListeners |
ComponentActionListenerホルダ | |
RTC::LightweightRTObject_var | m_insref |
SdoServiceConsumerTerminator * | m_sdoconterm |
RTコンポーネントクラス
各RTコンポーネントのベースとなるクラス。 Robotic Technology Component 仕様中の lightweightRTComponentの実装クラス。 コンポーネントの機能を提供する ComponentAction インターフェースと コンポーネントのライフサイクル管理を行うための LightweightRTObject の実装を 提供する。 実際にユーザがコンポーネントを作成する場合には、Execution Semantics に対応 した各サブクラスを利用する。
(現状の実装では Periodic Sampled Data Processing のみサポートしているため、 dataFlowComponent を直接継承している)
ExecutionContextActionListener リスナを追加する
ExecutionContextの追加、削除時にコールバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは ExecutionContextActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
ExecutionContextActionListener::operator()(UniqueId ec_id)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeExecutionContextActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
PostComponentActionListener リスナを追加する
ComponentAction 実装関数の呼び出し直後のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PostComponentActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PostComponentActionListener::operator()(UniqueId ec_id, ReturnCode_t ret)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePostComponentActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
PreComponentActionListener リスナを追加する
ComponentAction 実装関数の呼び出し直前のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PreComponentActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PreComponentActionListener::operator()(UniqueId ec_id)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePreComponentActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
explicit |
コンストラクタ
コンストラクタ
manager | マネージャオブジェクト |
RTC::RTObject_impl::RTObject_impl | ( | CORBA::ORB_ptr | orb, |
PortableServer::POA_ptr | poa ) |
コンストラクタ
コンストラクタ
orb | ORB |
poa | POA |
|
override |
仮想デストラクタ
ReturnCode_t RTC::RTObject_impl::activate | ( | RTC::UniqueId | ec_id | ) |
[local interface] 状態を Active に遷移させる
状態を Inactive から Active に遷移させる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数は上記の関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
|
inline |
void RTC::RTObject_impl::addConfigurationParamListener | ( | ConfigurationParamListenerType | type, |
ConfigurationParamListener * | listener, | ||
bool | autoclean = true ) |
ConfigurationParamListener を追加する
update(const char* config_set, const char* config_param) が呼ばれた際に コールされるリスナ ConfigurationParamListener を追加する。 type には現在のところ ON_UPDATE_CONFIG_PARAM のみが入る。
type | ConfigurationParamListenerType型の値。 ON_UPDATE_CONFIG_PARAM がある。 |
listener | ConfigurationParamListener 型のリスナオブジェクト。 |
autoclean | リスナオブジェクトを自動で削除するかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addConfigurationSetListener | ( | ConfigurationSetListenerType | type, |
ConfigurationSetListener * | listener, | ||
bool | autoclean = true ) |
ConfigurationSetListener を追加する
ConfigurationSet が更新されたときなどに呼ばれるリスナ ConfigurationSetListener を追加する。設定可能なイベントは以下の 2種類がある。
type | ConfigurationSetListenerType型の値。 |
listener | ConfigurationSetListener 型のリスナオブジェクト。 |
autoclean | リスナオブジェクトを自動で削除するかどうかのフラグ |
void RTC::RTObject_impl::addConfigurationSetNameListener | ( | ConfigurationSetNameListenerType | type, |
ConfigurationSetNameListener * | listener, | ||
bool | autoclean = true ) |
ConfigurationSetNameListener を追加する
ConfigurationSetName が更新されたときなどに呼ばれるリスナ ConfigurationSetNameListener を追加する。設定可能なイベントは以下の 3種類がある。
type | ConfigurationSetNameListenerType型の値。 |
listener | ConfigurationSetNameListener 型のリスナオブジェクト。 |
autoclean | リスナオブジェクトを自動で削除するかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addExecutionContextActionListener | ( | ECActionListenerType | listener_type, |
ECActionListener * | listener, | ||
bool | autoclean = true ) |
|
inline |
void RTC::RTObject_impl::addFsmProfileListener | ( | FsmProfileListenerType | listener_type, |
FsmProfileListener * | listener, | ||
bool | autoclean = true ) |
FsmProfileListener リスナを追加する
FSMへのプロファイルの設定、取得時、またFSM自体への状態や遷移、イ ベントの追加削除時にコールバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは FsmProfileListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
FsmProfileListener::operator()(RTC::FsmProfile& pprof)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeFsmProfileListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addFsmStructureListener | ( | FsmStructureListenerType | listener_type, |
FsmStructureListener * | listener, | ||
bool | autoclean = true ) |
FsmStructureListener リスナを追加する
ExtendedFsmService に関連する FSM structure の設定・取得時にコー ルバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは FsmStructureListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
FsmStructureListener::operator()(FsmStructure& structure)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removeFsmStructureListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
inline |
bool RTC::RTObject_impl::addInPort | ( | const char * | name, |
InPortBase & | inport ) |
[local interface] DataInPort を登録する
RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。
name | port 名称 |
inport | 登録対象 DataInPort |
bool RTC::RTObject_impl::addOutPort | ( | const char * | name, |
OutPortBase & | outport ) |
[local interface] DataOutPort を登録する
RTC が保持する DataOutPortを登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataOutPort の インスタンスを生成し、登録する。
name | port 名称 |
outport | 登録対象 DataOutPort |
bool RTC::RTObject_impl::addPort | ( | CorbaPort & | port | ) |
[local interface] Port を登録する
RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。
port | RTC に登録する Port |
bool RTC::RTObject_impl::addPort | ( | PortBase & | port | ) |
[local interface] Port を登録する
RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。
port | RTC に登録する Port |
bool RTC::RTObject_impl::addPort | ( | PortService_ptr | port | ) |
[local interface] Port を登録する
RTC が保持するPortを登録する。 Port を外部からアクセス可能にするためには、このオペレーションにより 登録されていなければならない。登録される Port はこの RTC 内部において PortProfile.name により区別される。したがって、Port は RTC 内において、 ユニークな PortProfile.name を持たなければならない。 登録された Port は内部で適切にアクティブ化された後、その参照と オブジェクト参照がリスト内に保存される。
port | RTC に登録する Port |
|
inline |
void RTC::RTObject_impl::addPortActionListener | ( | PortActionListenerType | listener_type, |
PortActionListener * | listener, | ||
bool | autoclean = true ) |
PortActionListener リスナを追加する
Portの追加、削除時にコールバックされる各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PortActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PortActionListener::operator()(PortProfile& pprof)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addPortConnectListener | ( | PortConnectListenerType | listener_type, |
PortConnectListener * | listener, | ||
bool | autoclean = true ) |
PortConnectListener リスナを追加する
Portの接続時や接続解除時に呼び出される各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PortConnectListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PortConnectListener::operator()(const char*, ConnectorProfile)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortConnectListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addPortConnectRetListener | ( | PortConnectRetListenerType | listener_type, |
PortConnectRetListener * | listener, | ||
bool | autoclean = true ) |
PortConnectRetListener リスナを追加する
Portの接続時や接続解除時に呼び出される各種リスナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PortConnectRetListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PortConnectRetListener::operator()(const char*, ConnectorProfile)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePortConnectRetListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addPostComponentActionListener | ( | PostComponentActionListenerType | listener_type, |
PostComponentActionListener * | listener, | ||
bool | autoclean = true ) |
|
inline |
void RTC::RTObject_impl::addPostFsmActionListener | ( | PostFsmActionListenerType | listener_type, |
PostFsmActionListener * | listener, | ||
bool | autoclean = true ) |
PostFsmActionListener リスナを追加する
FsmAction 実装関数の呼び出し直後のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PostFsmActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PostFsmActionListener::operator()(const char* state, ReturnCode_t ret)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePostFsmActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
|
inline |
void RTC::RTObject_impl::addPreComponentActionListener | ( | PreCompActionListenerType | listener_type, |
PreCompActionListener * | listener, | ||
bool | autoclean = true ) |
|
inline |
void RTC::RTObject_impl::addPreFsmActionListener | ( | PreFsmActionListenerType | listener_type, |
PreFsmActionListener * | listener, | ||
bool | autoclean = true ) |
PreFsmActionListener リスナを追加する
FsmAction 実装関数の呼び出し直前のイベントに関連する各種リ スナを設定する。
設定できるリスナのタイプとコールバックイベントは以下の通り
リスナは PreFsmActionListener を継承し、以下のシグニチャを持つ operator() を実装している必要がある。
PreFsmActionListener::operator()(UniqueId ec_id)
デフォルトでは、この関数に与えたリスナオブジェクトの所有権は RTObjectに移り、RTObject解体時もしくは、 removePreFsmActionListener() により削除時に自動的に解体される。 リスナオブジェクトの所有権を呼び出し側で維持したい場合は、第3引 数に false を指定し、自動的な解体を抑制することができる。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
autoclean | リスナオブジェクトの自動的解体を行うかどうかのフラグ |
bool RTC::RTObject_impl::addSdoServiceConsumer | ( | const SDOPackage::ServiceProfile & | prof | ) |
[local interface] SDO service provider をセットする
bool RTC::RTObject_impl::addSdoServiceProvider | ( | const SDOPackage::ServiceProfile & | prof, |
SdoServiceProviderBase * | provider ) |
[local interface] SDO service provider をセットする
|
override |
UniqueId RTC::RTObject_impl::bindContext | ( | ExecutionContext_ptr | exec_context | ) |
|
inline |
コンフィギュレーションパラメータの設定
コンフィギュレーションパラメータと変数をバインドする <VarType>としてコンフィギュレーションパラメータのデータ型を指定する。
param_name | コンフィギュレーションパラメータ名 |
var | コンフィギュレーションパラメータ格納用変数 |
def_val | コンフィギュレーションパラメータデフォルト値 |
trans | コンフィギュレーションパラメータ文字列変換用関数 |
参照先 RTC::ConfigAdmin::bindParameter(), m_configsets, RTC_TRACE.
|
protected |
creating, initializing and binding context
ReturnCode_t RTC::RTObject_impl::deactivate | ( | RTC::UniqueId | ec_id | ) |
[local interface] 状態を Inactive に遷移させる
状態を Active から Inactive に遷移させる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数は上記の関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
void RTC::RTObject_impl::deletePort | ( | CorbaPort & | port | ) |
void RTC::RTObject_impl::deletePort | ( | PortBase & | port | ) |
void RTC::RTObject_impl::deletePort | ( | PortService_ptr | port | ) |
void RTC::RTObject_impl::deletePortByName | ( | const char * | port_name | ) |
|
override |
[CORBA interface] ExecutionContextをdetachする
指定した ExecutionContext からこの RTC の所属を解除する。 このオペレーションは、ExecutionContextOperations::remove が呼ば れた際に呼び出される。返されたハンドルは他のクライアントで使用することを 想定していない。
制約
exec_handle | 解除対象 ExecutionContextハンドル |
|
override |
[CORBA interface] RTC がオーナーである ExecutionContext を 停止させ、そのコンテンツと共に終了させる
この RTC がオーナーであるすべての実行コンテキストを停止する。 この RTC が他の実行コンテキストを所有する RTC に属する実行コンテキスト (i.e. 実行コンテキストを所有する RTC はすなわちその実行コンテキストの オーナーである。)に参加している場合、当該 RTC はそれらのコンテキスト上 で非活性化されなければならない。 RTC が実行中のどの ExecutionContext でも Active 状態ではなくなった後、 この RTC とこれに含まれる RTC が終了する。
制約
|
override |
[CORBA interface] RTC を終了する
このオペレーション呼び出しの結果として ComponentAction::on_finalize() を呼び出す。
制約
void RTC::RTObject_impl::finalizeContexts | ( | ) |
ExecutionContextBaseリストの登録を削除する
|
protected |
Finalize my EC This function finalize mine ECs. This is called from only exit().
|
protected |
void RTC::RTObject_impl::finalizePorts | ( | ) |
全 Port の登録を削除する
RTC が保持する全ての Port を削除する。
|
staticprotected |
fiding existing EC from the factory
|
override |
[RTObject CORBA interface] コンポーネントプロファイルを取得する
当該コンポーネントのプロファイル情報を返す。
|
override |
[SDO interface] Configuration オブジェクトの取得
このオペレーションは Configuration interface への参照を返す。 Configuration interface は各 SDO を管理するためのインターフェースの ひとつである。このインターフェースは DeviceProfile, ServiceProfile, Organization で定義された SDO の属性値を設定するために使用される。 Configuration インターフェースの詳細については、OMG SDO specification の 2.3.5節, p.2-24 を参照のこと。
InterfaceNotImplemented | SDOはConfigurationインターフェースを 持たない。 |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
|
override |
[CORBA interface] ExecutionContext のハンドルを返す
与えられた実行コンテキストに関連付けられたハンドルを返す。
|
override |
[SDO interface] SDO DeviceProfile リストの取得
SDO の DeviceProfile を返すオペレーション。 SDO がハードウエアデバイス に関連付けられていない場合には、空の DeviceProfile が返される。 このオペレーションは以下の型の例外を発生させる。
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
[SDO interface] Monitoring オブジェクトの取得
このオペレーションは Monitoring interface への参照を返す。 Monitoring interface は SDO が管理するインターフェースの一つである。 このインターフェースは SDO のプロパティをモニタリングするために 使用される。 Monitoring interface の詳細については OMG SDO specification の 2.3.7節 "Monitoring Interface" p.2-35 を参照のこと。
InterfaceNotImplemented | SDOはConfigurationインターフェースを 持たない。 |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
[SDO interface] Organization リストの取得
SDO は0個以上の Organization (組織)に所属することができる。 もし SDO が 1個以上の Organization に所属している場合、このオペレーションは所属する Organization のリストを返す。SDO が どの Organization にも所属していない 場合には、空のリストが返される。
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
[CORBA interface] 所有する ExecutionContextListを 取得する
この RTC が所有する ExecutionContext のリストを取得する。
|
override |
[SDO interface] Organization リストの取得
SDOSystemElement は0個もしくはそれ以上の Organization を所有することが 出来る。 SDOSystemElement が1つ以上の Organization を所有している場合 には、このオペレーションは所有する Organization のリストを返す。 もしOrganizationを一つも所有していないければ空のリストを返す。
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
[CORBA interface] 参加している ExecutionContextList を取得する
この RTC が参加している ExecutionContext のリストを取得する。
|
override |
[RTObject CORBA interface] ポートを取得する
当該コンポーネントが保有するポートの参照を返す。
|
override |
|
override |
[SDO interface] 指定された SDO Service の取得
このオペレーションは引数 "id" で指定された名前によって区別される SDO の Service へのオブジェクト参照を返す。 SDO により提供される Service はそれぞれ一意の識別子により区別される。
id | SDO Service に関連付けられた識別子。 |
InvalidParameter | "id" で指定した ServiceProfile が存在しない。 "id" が null。 |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
|
override |
[SDO interface] 特定のServiceProfileの取得
引数 "id" で指定された名前のサービスの ServiceProfile を返す。
id | SDO Service の ServiceProfile に関連付けられた識別子。 |
InvalidParameter | "id" で指定した ServiceProfile が存在しない。 "id" が null。 |
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
[SDO interface] SDO ServiceProfile の取得
SDO が所有している Service の ServiceProfile を返すオペレーション。 SDO がサービスを一つも所有していない場合には、空のリストを返す。 このオペレーションは以下の型の例外を発生させる。
SDONotExists | ターゲットのSDOが存在しない。(本例外は、CORBA標準 システム例外のOBJECT_NOT_EXISTにマッピングされる) |
NotAvailable | SDOは存在するが応答がない。 |
InternalError | 内部的エラーが発生した。 |
|
override |
[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 | 内部的エラーが発生した。 |
|
override |
|
inline |
|
inline |
コンフィギュレーションサービスを取得する
コンフィギュレーションサービスオブジェクトを取得する。このサービ スオブジェクトを利用して、コンフィギュレーションパラメータの操作 を行うことができる。主な操作としては、
コールバック関連
詳細はConfigAdminクラスリファレンスを参照のこと。
参照先 m_configsets.
|
protected |
getting EC options
|
inline |
ExecutionContext_ptr RTC::RTObject_impl::getExecutionContext | ( | RTC::UniqueId | ec_id | ) |
[local interface] 実行コンテキストを取得する
get_context() と同じ機能のローカル版。違いはない。 この関数は以下の関数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
double RTC::RTObject_impl::getExecutionRate | ( | RTC::UniqueId | ec_id | ) |
[local interface] 実行コンテキストの実行レートを取得する
現在実行中の実行コンテキストの実行レートを取得する。実行コンテキ ストのKindがPERIODIC以外の場合の動作は未定義である。この関数は以 下の関数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
|
protected |
getting global EC options from rtc.conf
|
protected |
Get inherited EC options This function getting inherited EC options. This is called from only initMineEC().
|
inline |
参照先 m_inports.
|
inline |
std::vector< std::string > RTC::RTObject_impl::getNamingNames | ( | ) |
[local interface] Naming Server 情報の取得
設定された Naming Server 情報を返す。
RTObject_ptr RTC::RTObject_impl::getObjRef | ( | ) | const |
[local interface] オブジェクトリファレンスの取得
設定された CORBA オブジェクトリファレンスを取得する。
|
inline |
参照先 m_outports.
|
protected |
getting individual EC options from RTC's configuration file
coil::Properties & RTC::RTObject_impl::getProperties | ( | ) |
|
inline |
|
inline |
|
inline |
|
override |
|
protected |
Initialize my EC This function initializes mine ECs. This is called from only initialize().
|
protected |
initialize SDO service stuff This function calles SdoService's initialize().
|
override |
[CORBA interface] RTC が Alive 状態であるかどうか確認する。
RTC が指定した ExecutionContext に対して Alive状態であるかどうか 確認する。RTC の状態が Active であるか、Inactive であるか、 Error であるかは実行中のExecutionContext に依存する。すなわち、 ある ExecutionContext に対してはActive 状態であっても、他の ExecutionContext に対しては Inactive 状態となる場合もありえる。 従って、このオペレーションは指定されたExecutionContext に問い合 わせて、この RTC の状態が Active、Inactive、Error の場合には Alive 状態として返す。
|
static |
[local interface] 実行コンテキストの所有権を調べる
現在実行中の実行コンテキストの所有権を調べる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
|
override |
[ComponentAction CORBA interface] RTC のエラー状態への遷移
RTC が所属する ExecutionContext が Active 状態から Error 状態へ遷移した 場合に呼び出される。 このオペレーションは RTC が Error 状態に遷移した際に一度だけ呼び 出される。このオペレーション呼び出しの結果として onAborting() コー ルバック関数が呼び出される。
exec_handle | 状態遷移した ExecutionContext の ID |
|
override |
[ComponentAction CORBA interface] RTC の活性化
所属する ExecutionContext から RTC が活性化された際に呼び出される。 このオペレーション呼び出しの結果として onActivated() コールバック関数が 呼び出される。
exec_handle | 活性化 ExecutionContext の ID |
|
override |
[ComponentAction CORBA interface] RTC の非活性化
所属する ExecutionContext から RTC が非活性化された際に呼び出される。 このオペレーション呼び出しの結果として onDeactivated() コールバック関数が 呼び出される。
exec_handle | 非活性化 ExecutionContext の ID |
|
override |
[ComponentAction CORBA interface] RTC のエラー処理
RTC がエラー状態にいる際に呼び出される。 RTC がエラー状態の場合に、対象となる ExecutionContext のExecutionKind に 応じたタイミングで呼び出される。例えば、
exec_handle | 対象 ExecutionContext の ID |
|
override |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第一周期)
以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。
制約
exec_handle | 定常処理対象 ExecutionContext の ID |
|
override |
[ComponentAction CORBA interface] RTC の終了
RTC が破棄される。 RTC 固有の終了処理はここで実行する。 このオペレーション呼び出しの結果として onFinalize() コールバック関数が 呼び出される。
|
override |
[ComponentAction CORBA interface] RTC の初期化
RTC が初期化され、Alive 状態に遷移する。 RTC 固有の初期化処理はここで実行する。 このオペレーション呼び出しの結果として onInitialize() コールバック関数が 呼び出される。
|
override |
[DataFlowComponentAction CORBA interface] 実行周期変更通知
本オペレーションは、ExecutionContext の実行周期が変更されたことを通知する 際に呼び出される。 このオペレーション呼び出しの結果として onRateChanged() コールバック関数が 呼び出される。
制約
exec_handle | 定常処理対象 ExecutionContext の ID |
|
override |
|
override |
[ComponentAction CORBA interface] RTC の停止
RTC が所属する ExecutionContext が Running 状態から Stopped 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onShutdown() コールバック関数が 呼び出される。
exec_handle | 状態遷移した ExecutionContext の ID |
|
override |
[ComponentAction CORBA interface] RTC の開始
RTC が所属する ExecutionContext が Stopped 状態から Running 状態へ遷移 した場合に呼び出される。 このオペレーション呼び出しの結果として onStartup() コールバック関数が 呼び出される。
exec_handle | 状態遷移した ExecutionContext の ID |
|
override |
[DataFlowComponentAction CORBA interface] RTC の定常処理(第二周期)
以下の状態が保持されている場合に、設定された周期で定期的に呼び出される。
制約
exec_handle | 定常処理対象 ExecutionContext の ID |
|
protectedvirtual |
中断処理用コールバック関数
ComponentAction::on_aborting が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の中断処理は、本関数をオーバーライドして実装する 必要がある。
exec_handle | 参加している ExecutionContext の ID |
|
protectedvirtual |
活性化処理用コールバック関数
ComponentAction::on_activated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の活性化処理は、本関数をオーバーライドして実装する 必要がある。
exec_handle | 参加している ExecutionContext の ID |
RTC::PeriodicECSharedCompositeで再実装されています。
|
inline |
|
inline |
|
protectedvirtual |
非活性化処理用コールバック関数
ComponentAction::on_deactivated が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているの で、各コンポーネントの実際の非活性化処理は、本関数をオーバーライ ドして実装する必要がある。
exec_handle | 参加している ExecutionContext の ID |
RTC::PeriodicECSharedCompositeで再実装されています。
|
inline |
|
protectedvirtual |
エラー処理用コールバック関数
ComponentAction::on_error が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のエラー処理は、本関数をオーバーライドして実装する 必要がある。
exec_handle | 参加している ExecutionContext の ID |
|
protectedvirtual |
周期処理用コールバック関数
DataFlowComponentAction::on_execute が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の周期処理は、本関数をオーバーライドして実装する 必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの 1回目の実行パスとして定期的に呼び出される。
exec_handle | 参加している ExecutionContext の ID |
|
protectedvirtual |
終了処理用コールバック関数
ComponentAction::on_finalize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の終了処理は、本関数をオーバーライドして実装する 必要がある。
RTC::PeriodicECSharedCompositeで再実装されています。
|
protectedvirtual |
初期化処理用コールバック関数
ComponentAction::on_initialize が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の初期化処理は、本関数をオーバーライドして実装する 必要がある。
RTC::PeriodicECSharedCompositeで再実装されています。
|
protectedvirtual |
動作周期変更通知用コールバック関数
DataFlowComponentAction::on_rate_changed が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドし て実装する必要がある。
本関数は Periodic Sampled Data Processing において ExecutionContext の実行が更新された際に呼び 出される。
exec_handle | 参加している ExecutionContext の ID |
|
inline |
|
protectedvirtual |
リセット処理用コールバック関数
ComponentAction::on_reset が呼ばれた際に実行されるコールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際のリセット処理は、本関数をオーバーライドし て実装する必要がある。
exec_handle | 参加している ExecutionContext の ID |
RTC::PeriodicECSharedCompositeで再実装されています。
|
protectedvirtual |
停止処理用コールバック関数
ComponentAction::on_shutdown が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の停止処理は、本関数をオーバーライドして実装する 必要がある。
exec_handle | 参加している ExecutionContext の ID |
|
protectedvirtual |
開始処理用コールバック関数
ComponentAction::on_startup が呼ばれた際に実行されるコールバック 関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の開始処理は、本関数をオーバーライドして実装する 必要がある。
exec_handle | 参加している ExecutionContext の ID |
|
protectedvirtual |
状態変更処理用コールバック関数
DataFlowComponentAction::on_state_update が呼ばれた際に実行される コールバック関数。
本関数は無条件に RTC::RTC_OK を返すようにダミー実装されているので、 各コンポーネントの実際の状態変更処理は、本関数をオーバーライドし て実装する必要がある。
本関数は Periodic Sampled Data Processing における Two-Pass Executionの2回目の実行パスとして定 期的に呼び出される。
exec_handle | 参加している ExecutionContext の ID |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
FSM related listeners
参照先 m_fsmActionListeners, RTC::FsmActionListeners::notify(), RTC::POST_ON_INIT.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
FSM related listeners
参照先 m_fsmActionListeners, RTC::FsmActionListeners::notify(), RTC::PRE_ON_INIT.
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
bool RTC::RTObject_impl::readAll | ( | ) |
void RTC::RTObject_impl::registerInPort | ( | const char * | name, |
InPortBase & | inport ) |
[local interface] DataInPort を登録する
RTC が保持する DataInPort を登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataInPort の インスタンスを生成し、登録する。
name | port 名称 |
inport | 登録対象 DataInPort |
void RTC::RTObject_impl::registerOutPort | ( | const char * | name, |
OutPortBase & | outport ) |
[local interface] DataOutPort を登録する
RTC が保持する DataOutPortを登録する。 Port のプロパティにデータポートであること("port.dataport")、 TCPを使用すること("tcp_any")を設定するとともに、 DataOutPort の インスタンスを生成し、登録する。
name | port 名称 |
outport | 登録対象 DataOutPort |
void RTC::RTObject_impl::registerPort | ( | CorbaPort & | port | ) |
void RTC::RTObject_impl::registerPort | ( | PortBase & | port | ) |
void RTC::RTObject_impl::registerPort | ( | PortService_ptr | port | ) |
void RTC::RTObject_impl::removeConfigurationParamListener | ( | ConfigurationParamListenerType | type, |
ConfigurationParamListener * | listener ) |
ConfigurationParamListener を削除する
addConfigurationParamListener で追加されたリスナオブジェクトを削除する。
type | ConfigurationParamListenerType型の値。 ON_UPDATE_CONFIG_PARAM がある。 |
listener | 与えたリスナオブジェクトへのポインタ |
void RTC::RTObject_impl::removeConfigurationSetListener | ( | ConfigurationSetListenerType | type, |
ConfigurationSetListener * | listener ) |
ConfigurationSetListener を削除する
addConfigurationSetListener で追加されたリスナオブジェクトを削除する。
type | ConfigurationSetListenerType型の値。 |
listener | 与えたリスナオブジェクトへのポインタ |
void RTC::RTObject_impl::removeConfigurationSetNameListener | ( | ConfigurationSetNameListenerType | type, |
ConfigurationSetNameListener * | listener ) |
ConfigurationSetNameListener を削除する
addConfigurationSetNameListener で追加されたリスナオブジェクトを 削除する。
type | ConfigurationSetNameListenerType型の値。 ON_UPDATE_CONFIG_PARAM がある。 |
listener | 与えたリスナオブジェクトへのポインタ |
void RTC::RTObject_impl::removeExecutionContextActionListener | ( | ECActionListenerType | listener_type, |
ECActionListener * | listener ) |
ExecutionContextActionListener リスナを削除する
設定した各種リスナを削除する。
listener_type | リスナタイプ |
listener | リスナオブジェクトへのポインタ |
void RTC::RTObject_impl::removeFsmProfileListener | ( | FsmProfileListenerType | listener_type, |
FsmProfileListener * | listener ) |
void RTC::RTObject_impl::removeFsmStructureListener | ( | FsmStructureListenerType | listener_type, |
FsmStructureListener * | listener ) |
bool RTC::RTObject_impl::removeInPort | ( | InPortBase & | inport | ) |
bool RTC::RTObject_impl::removeOutPort | ( | OutPortBase & | outport | ) |
bool RTC::RTObject_impl::removePort | ( | CorbaPort & | port | ) |
[local interface] Port の登録を削除する
RTC が保持するPortの登録を削除する。
port | 削除対象 Port |
bool RTC::RTObject_impl::removePort | ( | PortBase & | port | ) |
[local interface] Port の登録を削除する
RTC が保持するPortの登録を削除する。
port | 削除対象 Port |
bool RTC::RTObject_impl::removePort | ( | PortService_ptr | port | ) |
[local interface] Port の登録を削除する
RTC が保持するPortの登録を削除する。
port | 削除対象 Port |
void RTC::RTObject_impl::removePortActionListener | ( | PortActionListenerType | listener_type, |
PortActionListener * | listener ) |
void RTC::RTObject_impl::removePortConnectListener | ( | PortConnectListenerType | listener_type, |
PortConnectListener * | listener ) |
void RTC::RTObject_impl::removePortConnectRetListener | ( | PortConnectRetListenerType | listener_type, |
PortConnectRetListener * | listener ) |
void RTC::RTObject_impl::removePostComponentActionListener | ( | PostComponentActionListenerType | listener_type, |
PostComponentActionListener * | listener ) |
void RTC::RTObject_impl::removePostFsmActionListener | ( | PostFsmActionListenerType | listener_type, |
PostFsmActionListener * | listener ) |
void RTC::RTObject_impl::removePreComponentActionListener | ( | PreComponentActionListenerType | listener_type, |
PreComponentActionListener * | listener ) |
void RTC::RTObject_impl::removePreFsmActionListener | ( | PreFsmActionListenerType | listener_type, |
PreFsmActionListener * | listener ) |
bool RTC::RTObject_impl::removeSdoServiceConsumer | ( | const char * | id | ) |
[local interface] SDO service provider を削除する
void RTC::RTObject_impl::removeSdoServiceConsumerStartThread | ( | const char * | id | ) |
[local interface] SDO service provider を別スレッドで削除する
bool RTC::RTObject_impl::removeSdoServiceProvider | ( | const char * | id | ) |
[local interface] SDO service provider を削除する
ReturnCode_t RTC::RTObject_impl::reset | ( | RTC::UniqueId | ec_id | ) |
[local interface] 状態をリセットし Inactive に遷移させる
状態を Error から Inactive に遷移させる。この関数は以下の関 数内で呼ばれることを前提としている。
この関数の引数は上記の関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
ReturnCode_t RTC::RTObject_impl::setExecutionRate | ( | RTC::UniqueId | ec_id, |
double | rate ) |
[local interface] 実行コンテキストの実行レートを設定する
現在実行中の実行コンテキストの実行レートを設定する。実行コンテキ ストのKindがPERIODIC以外の場合の動作は未定義である。この関数は以 下の関数内で呼ばれることを前提としている。
この関数の引数はこれらの関数の引数 UniquieID exec_handle でなけ ればならない。
ec_id | 上記関数の第1引数 exec_handle を渡す必要がある。 |
rate | 実行レートを [Hz] で与える |
void RTC::RTObject_impl::setINSObjRef | ( | RTC::LightweightRTObject_ptr | obj | ) |
omniINSPOAから取得したオブジェクトを登録
void RTC::RTObject_impl::setInstanceName | ( | const char * | instance_name | ) |
[local interface] インスタンス名の設定
ComponentProfile に指定されたインスタンス名を設定する。
instance_name | インスタンス名 |
void RTC::RTObject_impl::setObjRef | ( | RTObject_ptr | rtobj | ) |
void RTC::RTObject_impl::setProperties | ( | const coil::Properties & | prop | ) |
void RTC::RTObject_impl::setReadAll | ( | bool | read = true, |
bool | completion = false ) |
onExecute()実行前でのreadAll()メソッドの呼出を有効または無効にする。
このメソッドをパラメータをtrueとして呼ぶ事により、onExecute()実行前に readAll()が呼出されるようになる。 パラメータがfalseの場合は、readAll()呼出を無効にする。
void RTC::RTObject_impl::setWriteAll | ( | bool | write = true, |
bool | 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 |
|
protected |
|
protected |
Starting my EC This function start mine ECs. This is called from only initialize().
void RTC::RTObject_impl::updateParameters | ( | const char * | config_set | ) |
コンフィギュレーションパラメータの更新(ID指定)
指定したIDのコンフィギュレーションセットに設定した値で、 コンフィギュレーションパラメータの値を更新する
config_set | 設定対象のコンフィギュレーションセットID |
bool RTC::RTObject_impl::writeAll | ( | ) |
|
protected |
ComponentActionListenerホルダ
ComponentActionListenrを保持するホルダ
参照元 onAddPort(), onAttachExecutionContext(), onDetachExecutionContext(), onRemovePort(), postOnAborting(), postOnActivated(), postOnDeactivated(), postOnError(), postOnExecute(), postOnFinalize(), postOnInitialize(), postOnRateChanged(), postOnReset(), postOnShutdown(), postOnStartup(), postOnStateUpdate(), preOnAborting(), preOnActivated(), preOnDeactivated(), preOnError(), preOnExecute(), preOnFinalize(), preOnInitialize(), preOnRateChanged(), preOnReset(), preOnShutdown(), preOnStartup(), preOnStateUpdate() (計28項目).
|
protected |
コンフィギュレーション情報管理オブジェクト
|
protected |
Created 状態フラグ
|
protected |
ExecutionContextBase のリスト
|
protected |
自分がownerのExecutionContextService のリスト
|
protected |
参加しているExecutionContextService のリスト
|
protected |
RTCの終了状態フラグ
|
protected |
ComponentActionListenerホルダ
ComponentActionListenrを保持するホルダ
参照元 postOnFsmDo(), postOnFsmEntry(), postOnFsmExit(), postOnFsmInit(), postOnFsmStateChange(), preOnFsmDo(), preOnFsmEntry(), preOnFsmExit(), preOnFsmInit(), preOnFsmStateChange().
|
protected |
InPortBase* のリスト
参照元 getInPorts().
|
protected |
|
protected |
オブジェクトリファレンス
|
protected |
OutPortBase* のリスト
参照元 getOutPorts().
|
protected |
マネージャオブジェクト
|
protected |
ORB へのポインタ
|
protected |
Port のオブジェクトリファレンスのリスト
|
protected |
PortConnectListenerホルダ
PortConnectListenrを保持するホルダ
|
protected |
POA へのポインタ
|
protected |
コンポーネントプロファイル
参照元 getCategory(), getDescription(), getInstanceName(), getTypeName(), getVendor(), getVersion().
|
protected |
RTC のプロパティ
|
protected |
SDO Configuration Interface へのポインタ
|
protected |
SDO Configuration オブジェクトへのポインタ
|
protected |
readAll()呼出用のフラグ
|
protected |
|
protected |
|
protected |
SDO organization
|
protected |
SDO が保持する organization のリスト
|
protected |
SDO Service 管理オブジェクト
|
protected |
SDO Status
|
protected |
writeAll()呼出用のフラグ
|
protected |
writeAll()用のフラグ
true:writeAll()の途中ででエラーが発生しても最後まで実施する。 false:writeAll()の途中ででエラーが発生した場合終了。
|
mutableprotected |
ロガーストリーム