OpenRTM-aist 2.0.2
|
クラス | |
struct | find_port |
ポートを名前から検索 [詳解] | |
関数 | |
coil::Properties | get_component_profile (RTC::RTObject_ptr rtc) |
RTC操作ユーティリティー関数群 | |
bool | is_existing (RTC::RTObject_ptr rtc) |
コンポーネントのオブジェクトリファレンスが存在しているかを判定 | |
bool | is_alive_in_default_ec (RTC::RTObject_ptr rtc) |
RTCがデフォルトの実行コンテキストでalive状態かを判定する | |
RTC::ExecutionContext_ptr | get_actual_ec (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
RTコンポーネントに関連付けした実行コンテキストから指定したIDの実行コンテキストを取得 | |
RTC::UniqueId | get_ec_id (RTC::RTObject_ptr rtc, RTC::ExecutionContext_ptr ec) |
対象のRTコンポーネントから指定した実行コンテキストのIDを取得する | |
RTC::ReturnCode_t | activate (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
RTCを指定した実行コンテキストでアクティベーションする | |
RTC::ReturnCode_t | deactivate (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
RTCを指定した実行コンテキストで非アクティベーションする | |
RTC::ReturnCode_t | reset (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
RTCを指定した実行コンテキストでリセットする | |
bool | get_state (RTC::LifeCycleState &state, RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
対象のRTコンポーネントの指定した実行コンテキストでの状態を取得 | |
bool | is_in_inactive (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
対象のRTコンポーネントの指定したECでINACTIVE状態かどうか判定 | |
bool | is_in_active (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
対象のRTコンポーネントの指定したECでACTIVE状態かどうか判定 | |
bool | is_in_error (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id=0) |
対象のRTコンポーネントの指定したECでERROR状態かどうか判定 | |
CORBA::Double | get_default_rate (RTC::RTObject_ptr rtc) |
RTCのデフォルトの実行コンテキストの実行周期を取得する | |
RTC::ReturnCode_t | set_default_rate (RTC::RTObject_ptr rtc, CORBA::Double rate) |
RTCのデフォルトの実行コンテキストの実行周期を設定する | |
CORBA::Double | get_current_rate (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id) |
RTCの指定IDの実行コンテキストの周期を取得 | |
RTC::ReturnCode_t | set_current_rate (RTC::RTObject_ptr rtc, RTC::UniqueId ec_id, CORBA::Double rate) |
RTCの指定IDの実行コンテキストの周期を設定 | |
RTC::ReturnCode_t | add_rtc_to_default_ec (RTC::RTObject_ptr localcomp, RTC::RTObject_ptr othercomp) |
対象のRTCのデフォルトの実行コンテキストに指定のRTCを関連付ける | |
RTC::ReturnCode_t | remove_rtc_to_default_ec (RTC::RTObject_ptr localcomp, RTC::RTObject_ptr othercomp) |
対象のRTCのデフォルトのECの指定のRTCへの関連付けを解除する | |
RTC::RTCList | get_participants_rtc (RTC::RTObject_ptr rtc) |
RTCのデフォルトの実行コンテキストに参加しているRTCのリストを取得する 実行コンテキストがnilの場合は空のリストを返す | |
coil::vstring | get_port_names (RTC::RTObject_ptr rtc) |
指定したRTCの保持するポートの名前を取得 | |
coil::vstring | get_inport_names (RTC::RTObject_ptr rtc) |
指定したRTCの保持するインポートの名前を取得 | |
coil::vstring | get_outport_names (RTC::RTObject_ptr rtc) |
指定したRTCの保持するアウトポートの名前を取得 | |
coil::vstring | get_svcport_names (RTC::RTObject_ptr rtc) |
指定したRTCの保持するサービスポートの名前を取得 | |
coil::vstring | get_connector_names (RTC::PortService_ptr port) |
指定したポートの保持しているコネクタの名前のリストを取得 | |
coil::vstring | get_connector_names (RTC::RTObject_ptr rtc, const std::string &port_name) |
対象のRTCの指定したポートのコネクタの名前のリストを取得 | |
coil::vstring | get_connector_ids (RTC::PortService_ptr port) |
指定したポートの保持しているコネクタのIDのリストを取得 | |
coil::vstring | get_connector_ids (RTC::RTObject_ptr rtc, const std::string &port_name) |
対象のRTCの指定したポートのコネクタのIDのリストを取得 | |
RTC::ConnectorProfile * | create_connector (const std::string &name, const coil::Properties &prop_arg, RTC::PortService_ptr port0, RTC::PortService_ptr port1) |
指定したポートを接続するためのコネクタプロファイルを取得 | |
bool | already_connected (RTC::PortService_ptr localport, RTC::PortService_ptr otherport) |
指定したポート同士が接続されているかを判定 | |
RTC::ReturnCode_t | connect (const std::string &name, const coil::Properties &prop, RTC::PortService_ptr port0, RTC::PortService_ptr port1) |
指定したポートを接続する | |
RTC::ReturnCode_t | disconnect (RTC::ConnectorProfile connector_prof) |
対象のRTCの指定したポートのコネクタのIDのリストを取得 | |
RTC::ReturnCode_t | disconnect_connector_name (RTC::PortService_ptr port_ref, const std::string &conn_name) |
対象のポートで指定した名前のコネクタを切断 | |
RTC::ReturnCode_t | disconnect_connector_name (const std::string &port_name, const std::string &conn_name) |
対象の名前のポートで指定した名前のコネクタを切断 | |
RTC::ReturnCode_t | disconnect_connector_id (RTC::PortService_ptr port_ref, const std::string &conn_id) |
対象のポートで指定したIDのコネクタを切断 | |
RTC::ReturnCode_t | disconnect_connector_id (const std::string &port_name, const std::string &conn_id) |
対象の名前のポートで指定したIDのコネクタを切断 | |
RTC::ReturnCode_t | disconnect_all (RTC::PortService_ptr port_ref) |
対象のポートのコネクタを全て切断 | |
RTC::ReturnCode_t | disconnect_all (const std::string &port_name) |
指定ポート名のポートのコネクタを全て切断 | |
RTC::PortService_ptr | get_port_by_url (const std::string &port_name) |
指定した名前のポートを取得 | |
RTC::ReturnCode_t | disconnect_name (RTC::PortService_ptr localport, const std::string &othername) |
対象ポートと接続しているポートで指定したポート名と一致した場合に切断 | |
RTC::ReturnCode_t | connect_multi (const std::string &name, const coil::Properties &prop, RTC::PortService_ptr port, RTC::PortServiceList &target_ports) |
指定したポートと指定したリスト内のポート全てと接続する | |
RTC::PortService_ptr | get_port_by_name (RTC::RTObject_ptr rtc, const std::string &name) |
対象のRTCから指定した名前のポートを取得 | |
RTC::ReturnCode_t | connect_by_name (const std::string &name, const coil::Properties &prop, RTC::RTObject_ptr rtc0, const std::string &portName0, RTC::RTObject_ptr rtc1, const std::string &portName1) |
対象のRTCの指定した名前のポートを接続する | |
coil::Properties | get_configuration (RTC::RTObject_ptr rtc, const std::string &conf_name) |
対象RTCの指定した名前のコンフィギュレーションセットをkey-valueで取得 | |
std::string | get_parameter_by_key (RTC::RTObject_ptr rtc, const std::string &confset_name, const std::string &value_name) |
指定したコンフィギュレーションセット名、パラメータ名のコン フィギュレーションパラメータを取得 | |
std::string | get_active_configuration_name (RTC::RTObject_ptr rtc) |
対象のRTCのアクティブなコンフィギュレーションセット名を取得する | |
coil::Properties | get_active_configuration (RTC::RTObject_ptr rtc) |
アクティブなコンフィギュレーションセットをkey-valueで取得する | |
bool | set_configuration (RTC::RTObject_ptr rtc, const std::string &confset_name, const std::string &value_name, const std::string &value) |
コンフィギュレーションパラメータを設定 | |
bool | set_active_configuration (RTC::RTObject_ptr rtc, const std::string &value_name, const std::string &value) |
アクティブなコンフィギュレーションセットのパラメータを設定 | |
bool | set_configuration_parameter (SDOPackage::Configuration_ptr conf, SDOPackage::ConfigurationSet &confset, const std::string &value_name, const std::string &value) |
コンフィギュレーションパラメータの設定 | |
RTC::ReturnCode_t CORBA_RTCUtil::activate | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
RTCを指定した実行コンテキストでアクティベーションする
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
RTC::ReturnCode_t CORBA_RTCUtil::add_rtc_to_default_ec | ( | RTC::RTObject_ptr | localcomp, |
RTC::RTObject_ptr | othercomp ) |
対象のRTCのデフォルトの実行コンテキストに指定のRTCを関連付ける
localcomp | 対象のRTコンポーネント |
othercomp | 実行コンテキストに関連付けるRTコンポーネント |
bool CORBA_RTCUtil::already_connected | ( | RTC::PortService_ptr | localport, |
RTC::PortService_ptr | otherport ) |
指定したポート同士が接続されているかを判定
port0 | 対象のポート1 |
port1 | 対象のポート2 |
RTC::ReturnCode_t CORBA_RTCUtil::connect | ( | const std::string & | name, |
const coil::Properties & | prop, | ||
RTC::PortService_ptr | port0, | ||
RTC::PortService_ptr | port1 ) |
指定したポートを接続する
name | コネクタ名 |
prop | 設定 |
port0 | 対象のポート1 |
port1 | 対象のポート2 |
RTC::ReturnCode_t CORBA_RTCUtil::connect_by_name | ( | const std::string & | name, |
const coil::Properties & | prop, | ||
RTC::RTObject_ptr | rtc0, | ||
const std::string & | portName0, | ||
RTC::RTObject_ptr | rtc1, | ||
const std::string & | portName1 ) |
対象のRTCの指定した名前のポートを接続する
name | コネクタ名 |
prop | 設定 |
rtc0 | 対象のRTCコンポーネント1 |
portName0 | 対象のポート名1 |
rtc1 | 対象のRTCコンポーネント2 |
portName1 | 対象のRTCコンポーネント2 |
RTC::ReturnCode_t CORBA_RTCUtil::connect_multi | ( | const std::string & | name, |
const coil::Properties & | prop, | ||
RTC::PortService_ptr | port, | ||
RTC::PortServiceList & | target_ports ) |
指定したポートと指定したリスト内のポート全てと接続する
name | コネクタ名 |
prop | 設定 |
port | 対象のポート |
target_ports | 対象のポートのリスト |
RTC::ConnectorProfile * CORBA_RTCUtil::create_connector | ( | const std::string & | name, |
const coil::Properties & | prop_arg, | ||
RTC::PortService_ptr | port0, | ||
RTC::PortService_ptr | port1 ) |
指定したポートを接続するためのコネクタプロファイルを取得
name | コネクタ名 |
prop_arg | 設定 |
port0 | 対象のポート1 |
port1 | 対象のポート2 |
RTC::ReturnCode_t CORBA_RTCUtil::deactivate | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
RTCを指定した実行コンテキストで非アクティベーションする
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect | ( | RTC::ConnectorProfile | connector_prof | ) |
対象のRTCの指定したポートのコネクタのIDのリストを取得
port | RTコンポーネント |
port_name | ポート名 |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_all | ( | const std::string & | port_name | ) |
指定ポート名のポートのコネクタを全て切断
port_name | ポート名 |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_all | ( | RTC::PortService_ptr | port_ref | ) |
対象のポートのコネクタを全て切断
port_ref | ポートのオブジェクトリファレンス |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_id | ( | const std::string & | port_name, |
const std::string & | conn_id ) |
対象の名前のポートで指定したIDのコネクタを切断
port | 対象のポート |
name | コネクタID |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_id | ( | RTC::PortService_ptr | port_ref, |
const std::string & | conn_id ) |
対象のポートで指定したIDのコネクタを切断
port | 対象のポート |
name | コネクタID |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_name | ( | const std::string & | port_name, |
const std::string & | conn_name ) |
対象の名前のポートで指定した名前のコネクタを切断
port_name | 対象のポート名 |
conn_name | コネクタ名 |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_name | ( | RTC::PortService_ptr | port_ref, |
const std::string & | conn_name ) |
対象のポートで指定した名前のコネクタを切断
port_ref | 対象のポート |
conn_name | コネクタ名 |
RTC::ReturnCode_t CORBA_RTCUtil::disconnect_name | ( | RTC::PortService_ptr | localport, |
const std::string & | othername ) |
対象ポートと接続しているポートで指定したポート名と一致した場合に切断
localport | 対象のポート |
othername | 接続しているポート名 |
coil::Properties CORBA_RTCUtil::get_active_configuration | ( | RTC::RTObject_ptr | rtc | ) |
アクティブなコンフィギュレーションセットをkey-valueで取得する
rtc | 対象のRTコンポーネント |
std::string CORBA_RTCUtil::get_active_configuration_name | ( | RTC::RTObject_ptr | rtc | ) |
対象のRTCのアクティブなコンフィギュレーションセット名を取得する
rtc | RTコンポーネント |
RTC::ExecutionContext_ptr CORBA_RTCUtil::get_actual_ec | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
RTコンポーネントに関連付けした実行コンテキストから指定したIDの実行コンテキストを取得
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
coil::Properties CORBA_RTCUtil::get_component_profile | ( | RTC::RTObject_ptr | rtc | ) |
RTC操作ユーティリティー関数群
Getting component profile This is an example obtained properties from a RTC.
コンポーネントのプロパティ取得
rtc | RTコンポーネント |
coil::Properties CORBA_RTCUtil::get_configuration | ( | RTC::RTObject_ptr | rtc, |
const std::string & | conf_name ) |
対象RTCの指定した名前のコンフィギュレーションセットをkey-valueで取得
rtc | 対象のRTコンポーネント |
conf_name | コンフィギュレーションセット名 |
coil::vstring CORBA_RTCUtil::get_connector_ids | ( | RTC::PortService_ptr | port | ) |
指定したポートの保持しているコネクタのIDのリストを取得
port | 対象のポート |
coil::vstring CORBA_RTCUtil::get_connector_ids | ( | RTC::RTObject_ptr | rtc, |
const std::string & | port_name ) |
対象のRTCの指定したポートのコネクタのIDのリストを取得
port | RTコンポーネント |
port_name | ポート名 |
coil::vstring CORBA_RTCUtil::get_connector_names | ( | RTC::PortService_ptr | port | ) |
指定したポートの保持しているコネクタの名前のリストを取得
port | 対象のポート |
coil::vstring CORBA_RTCUtil::get_connector_names | ( | RTC::RTObject_ptr | rtc, |
const std::string & | port_name ) |
対象のRTCの指定したポートのコネクタの名前のリストを取得
rtc | 対象のRTコンポーネント |
port_name | ポート名 |
CORBA::Double CORBA_RTCUtil::get_current_rate | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id ) |
RTCの指定IDの実行コンテキストの周期を取得
rtc | RTコンポーネント |
ec_id | 指定の実行コンテキストのID |
CORBA::Double CORBA_RTCUtil::get_default_rate | ( | RTC::RTObject_ptr | rtc | ) |
RTCのデフォルトの実行コンテキストの実行周期を取得する
rtc | RTコンポーネント |
RTC::UniqueId CORBA_RTCUtil::get_ec_id | ( | RTC::RTObject_ptr | rtc, |
RTC::ExecutionContext_ptr | ec ) |
対象のRTコンポーネントから指定した実行コンテキストのIDを取得する
rtc | RTコンポーネント |
ec | 実行コンテキスト |
coil::vstring CORBA_RTCUtil::get_inport_names | ( | RTC::RTObject_ptr | rtc | ) |
指定したRTCの保持するインポートの名前を取得
rtc | 対象のRTコンポーネント |
coil::vstring CORBA_RTCUtil::get_outport_names | ( | RTC::RTObject_ptr | rtc | ) |
指定したRTCの保持するアウトポートの名前を取得
rtc | 対象のRTコンポーネント |
std::string CORBA_RTCUtil::get_parameter_by_key | ( | RTC::RTObject_ptr | rtc, |
const std::string & | confset_name, | ||
const std::string & | value_name ) |
指定したコンフィギュレーションセット名、パラメータ名のコン フィギュレーションパラメータを取得
rtc | RTコンポーネント |
confset_name | コンフィギュレーションセット名 |
value_name | パラメータ名 |
RTC::RTCList CORBA_RTCUtil::get_participants_rtc | ( | RTC::RTObject_ptr | rtc | ) |
RTCのデフォルトの実行コンテキストに参加しているRTCのリストを取得する 実行コンテキストがnilの場合は空のリストを返す
rtc | 対象のRTコンポーネント |
RTC::PortService_ptr CORBA_RTCUtil::get_port_by_name | ( | RTC::RTObject_ptr | rtc, |
const std::string & | name ) |
対象のRTCから指定した名前のポートを取得
rtc | RTコンポーネント |
port_name | ポート名 |
RTC::PortService_ptr CORBA_RTCUtil::get_port_by_url | ( | const std::string & | port_name | ) |
指定した名前のポートを取得
port_name | ポート名 |
coil::vstring CORBA_RTCUtil::get_port_names | ( | RTC::RTObject_ptr | rtc | ) |
指定したRTCの保持するポートの名前を取得
rtc | 対象のRTコンポーネント |
bool CORBA_RTCUtil::get_state | ( | RTC::LifeCycleState & | state, |
RTC::RTObject_ptr | rtc, | ||
RTC::UniqueId | ec_id = 0 ) |
対象のRTコンポーネントの指定した実行コンテキストでの状態を取得
state | RTCの状態 |
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
coil::vstring CORBA_RTCUtil::get_svcport_names | ( | RTC::RTObject_ptr | rtc | ) |
指定したRTCの保持するサービスポートの名前を取得
rtc | 対象のRTコンポーネント |
bool CORBA_RTCUtil::is_alive_in_default_ec | ( | RTC::RTObject_ptr | rtc | ) |
RTCがデフォルトの実行コンテキストでalive状態かを判定する
rtc | RTコンポーネント |
bool CORBA_RTCUtil::is_existing | ( | RTC::RTObject_ptr | rtc | ) |
コンポーネントのオブジェクトリファレンスが存在しているかを判定
rtc | RTコンポーネント |
bool CORBA_RTCUtil::is_in_active | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
対象のRTコンポーネントの指定したECでACTIVE状態かどうか判定
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
bool CORBA_RTCUtil::is_in_error | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
対象のRTコンポーネントの指定したECでERROR状態かどうか判定
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
bool CORBA_RTCUtil::is_in_inactive | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
対象のRTコンポーネントの指定したECでINACTIVE状態かどうか判定
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
RTC::ReturnCode_t CORBA_RTCUtil::remove_rtc_to_default_ec | ( | RTC::RTObject_ptr | localcomp, |
RTC::RTObject_ptr | othercomp ) |
対象のRTCのデフォルトのECの指定のRTCへの関連付けを解除する
localcomp | 対象のRTコンポーネント |
othercomp | 実行コンテキストとの関連付けを解除するRTコンポーネント |
RTC::ReturnCode_t CORBA_RTCUtil::reset | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id = 0 ) |
RTCを指定した実行コンテキストでリセットする
rtc | 対象のRTコンポーネント |
ec_id | 実行コンテキストのID |
bool CORBA_RTCUtil::set_active_configuration | ( | RTC::RTObject_ptr | rtc, |
const std::string & | value_name, | ||
const std::string & | value ) |
アクティブなコンフィギュレーションセットのパラメータを設定
rtc | 対象のRTコンポーネント |
value_name | パラメータ名 |
value | パラメータ |
bool CORBA_RTCUtil::set_configuration | ( | RTC::RTObject_ptr | rtc, |
const std::string & | confset_name, | ||
const std::string & | value_name, | ||
const std::string & | value ) |
コンフィギュレーションパラメータを設定
rtc | 対象のRTコンポーネント |
confset_name | コンフィギュレーションセット名 |
value_name | パラメータ名 |
value | パラメータ |
bool CORBA_RTCUtil::set_configuration_parameter | ( | SDOPackage::Configuration_ptr | conf, |
SDOPackage::ConfigurationSet & | confset, | ||
const std::string & | value_name, | ||
const std::string & | value ) |
コンフィギュレーションパラメータの設定
conf | コンフィギュレーション |
confset | コンフィギュレーションセット |
value_name | パラメータ名 |
value | パラメータ |
RTC::ReturnCode_t CORBA_RTCUtil::set_current_rate | ( | RTC::RTObject_ptr | rtc, |
RTC::UniqueId | ec_id, | ||
CORBA::Double | rate ) |
RTCの指定IDの実行コンテキストの周期を設定
rtc | RTコンポーネント |
ec_id | 指定の実行コンテキストのID |
rate | 実行周期 |
RTC::ReturnCode_t CORBA_RTCUtil::set_default_rate | ( | RTC::RTObject_ptr | rtc, |
CORBA::Double | rate ) |
RTCのデフォルトの実行コンテキストの実行周期を設定する
rtc | RTコンポーネント |
rate | 実行周期 |