クラス
class	CorbaURI
	CorbaURI クラス指定のCORBAオブジェクト参照用URLから参照形式、ホスト名、ポート番号、パス、オブジェクトキーを取得する機能を提供するクラス [詳解]

struct	find_port
	ポートを名前から検索 [詳解]

class	RTCURIObject
	RTCURIObject クラス rtcname形式、rtcloc形式のURIから通信先のアドレス、RTC名等を取得する機能を提供するクラス rtcname形式は以下のようにrtcname.{通信プロトコル}/{アドレス}/{ネームサーバーでの登録パス} で指定可能である。通信プロトコルを省略するとiiopに設定する。 [詳解]

関数
coil::Properties	get_component_profile (const RTC::RTObject_ptr rtc)
	RTC操作ユーティリティー関数群 [詳解]

bool	is_existing (const RTC::RTObject_ptr rtc)
	コンポーネントのオブジェクトリファレンスが存在しているかを判定 [詳解]

bool	is_alive_in_default_ec (const RTC::RTObject_ptr rtc)
	RTCがデフォルトの実行コンテキストでalive状態かを判定する [詳解]

RTC::ExecutionContext_ptr	get_actual_ec (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	RTコンポーネントに関連付けした実行コンテキストから指定したIDの実行コンテキストを取得 [詳解]

RTC::UniqueId	get_ec_id (const RTC::RTObject_ptr rtc, const RTC::ExecutionContext_ptr ec)
	対象のRTコンポーネントから指定した実行コンテキストのIDを取得する [詳解]

RTC::ReturnCode_t	activate (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	RTCを指定した実行コンテキストでアクティベーションする [詳解]

RTC::ReturnCode_t	deactivate (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	RTCを指定した実行コンテキストで非アクティベーションする [詳解]

RTC::ReturnCode_t	reset (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	RTCを指定した実行コンテキストでリセットする [詳解]

bool	get_state (RTC::LifeCycleState &state, const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	対象のRTコンポーネントの指定した実行コンテキストでの状態を取得 [詳解]

bool	is_in_inactive (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	対象のRTコンポーネントの指定したECでINACTIVE状態かどうか判定 [詳解]

bool	is_in_active (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	対象のRTコンポーネントの指定したECでACTIVE状態かどうか判定 [詳解]

bool	is_in_error (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id=0)
	対象のRTコンポーネントの指定したECでERROR状態かどうか判定 [詳解]

CORBA::Double	get_default_rate (const RTC::RTObject_ptr rtc)
	RTCのデフォルトの実行コンテキストの実行周期を取得する [詳解]

RTC::ReturnCode_t	set_default_rate (const RTC::RTObject_ptr rtc, CORBA::Double rate)
	RTCのデフォルトの実行コンテキストの実行周期を設定する [詳解]

CORBA::Double	get_current_rate (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id)
	RTCの指定IDの実行コンテキストの周期を取得 [詳解]

RTC::ReturnCode_t	set_current_rate (const RTC::RTObject_ptr rtc, const RTC::UniqueId ec_id, const CORBA::Double rate)
	RTCの指定IDの実行コンテキストの周期を設定 [詳解]

RTC::ReturnCode_t	add_rtc_to_default_ec (const RTC::RTObject_ptr localcomp, const RTC::RTObject_ptr othercomp)
	対象のRTCのデフォルトの実行コンテキストに指定のRTCを関連付ける [詳解]

RTC::ReturnCode_t	remove_rtc_to_default_ec (const RTC::RTObject_ptr localcomp, const RTC::RTObject_ptr othercomp)
	対象のRTCのデフォルトのECの指定のRTCへの関連付けを解除する [詳解]

RTC::RTCList	get_participants_rtc (const RTC::RTObject_ptr rtc)
	RTCのデフォルトの実行コンテキストに参加しているRTCのリストを取得する実行コンテキストがnilの場合は空のリストを返す [詳解]

coil::vstring	get_port_names (const RTC::RTObject_ptr rtc)
	指定したRTCの保持するポートの名前を取得 [詳解]

coil::vstring	get_inport_names (const RTC::RTObject_ptr rtc)
	指定したRTCの保持するインポートの名前を取得 [詳解]

coil::vstring	get_outport_names (const RTC::RTObject_ptr rtc)
	指定したRTCの保持するアウトポートの名前を取得 [詳解]

coil::vstring	get_svcport_names (const RTC::RTObject_ptr rtc)
	指定したRTCの保持するサービスポートの名前を取得 [詳解]

coil::vstring	get_connector_names (const RTC::PortService_ptr port)
	指定したポートの保持しているコネクタの名前のリストを取得 [詳解]

coil::vstring	get_connector_names (const RTC::RTObject_ptr rtc, const std::string &port_name)
	対象のRTCの指定したポートのコネクタの名前のリストを取得 [詳解]

coil::vstring	get_connector_ids (const RTC::PortService_ptr port)
	指定したポートの保持しているコネクタのIDのリストを取得 [詳解]

coil::vstring	get_connector_ids (const RTC::RTObject_ptr rtc, const std::string &port_name)
	対象のRTCの指定したポートのコネクタのIDのリストを取得 [詳解]

RTC::ConnectorProfile *	create_connector (const std::string &name, const coil::Properties &prop_arg, const RTC::PortService_ptr port0, const RTC::PortService_ptr port1)
	指定したポートを接続するためのコネクタプロファイルを取得 [詳解]

bool	already_connected (const RTC::PortService_ptr localport, const RTC::PortService_ptr otherport)
	指定したポート同士が接続されているかを判定 [詳解]

RTC::ReturnCode_t	connect (const std::string &name, const coil::Properties &prop, const RTC::PortService_ptr port0, const RTC::PortService_ptr port1)
	指定したポートを接続する [詳解]

RTC::ReturnCode_t	disconnect (const RTC::ConnectorProfile connector_prof)
	対象のRTCの指定したポートのコネクタのIDのリストを取得 [詳解]

RTC::ReturnCode_t	disconnect_connector_name (const 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 (const 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 (const 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 (const RTC::PortService_ptr localport, const std::string &othername)
	対象ポートと接続しているポートで指定したポート名と一致した場合に切断 [詳解]

RTC::ReturnCode_t	connect_multi (const std::string &name, const coil::Properties &prop, const RTC::PortService_ptr port, RTC::PortServiceList &target_ports)
	指定したポートと指定したリスト内のポート全てと接続する [詳解]

RTC::PortService_ptr	get_port_by_name (const RTC::RTObject_ptr rtc, const std::string &name)
	対象のRTCから指定した名前のポートを取得 [詳解]

RTC::ReturnCode_t	connect_by_name (const std::string &name, const coil::Properties &prop, const RTC::RTObject_ptr rtc0, const std::string &portName0, const RTC::RTObject_ptr rtc1, const std::string &portName1)
	対象のRTCの指定した名前のポートを接続する [詳解]

coil::Properties	get_configuration (const RTC::RTObject_ptr rtc, const std::string &conf_name)
	対象RTCの指定した名前のコンフィギュレーションセットをkey-valueで取得 [詳解]

std::string	get_parameter_by_key (const RTC::RTObject_ptr rtc, const std::string &confset_name, const std::string &value_name)
	指定したコンフィギュレーションセット名、パラメータ名のコンフィギュレーションパラメータを取得 [詳解]

std::string	get_active_configuration_name (const RTC::RTObject_ptr rtc)
	対象のRTCのアクティブなコンフィギュレーションセット名を取得する [詳解]

coil::Properties	get_active_configuration (const RTC::RTObject_ptr rtc)
	アクティブなコンフィギュレーションセットをkey-valueで取得する [詳解]

bool	set_configuration (const RTC::RTObject_ptr rtc, const std::string &confset_name, const std::string &value_name, const std::string &value)
	コンフィギュレーションパラメータを設定 [詳解]

bool	set_active_configuration (const 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)
	コンフィギュレーションパラメータの設定 [詳解]

関数詳解

◆ activate()

RTC::ReturnCode_t CORBA_RTCUtil::activate	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

RTCを指定した実行コンテキストでアクティベーションする

◆ add_rtc_to_default_ec()

RTC::ReturnCode_t CORBA_RTCUtil::add_rtc_to_default_ec	(	const RTC::RTObject_ptr	localcomp,
		const RTC::RTObject_ptr	othercomp
	)

対象のRTCのデフォルトの実行コンテキストに指定のRTCを関連付ける

◆ already_connected()

bool CORBA_RTCUtil::already_connected	(	const RTC::PortService_ptr	localport,
		const RTC::PortService_ptr	otherport
	)

指定したポート同士が接続されているかを判定

◆ connect()

RTC::ReturnCode_t CORBA_RTCUtil::connect	(	const std::string &	name,
		const coil::Properties &	prop,
		const RTC::PortService_ptr	port0,
		const RTC::PortService_ptr	port1
	)

指定したポートを接続する

◆ connect_by_name()

RTC::ReturnCode_t CORBA_RTCUtil::connect_by_name	(	const std::string &	name,
		const coil::Properties &	prop,
		const RTC::RTObject_ptr	rtc0,
		const std::string &	portName0,
		const RTC::RTObject_ptr	rtc1,
		const std::string &	portName1
	)

対象のRTCの指定した名前のポートを接続する

◆ connect_multi()

RTC::ReturnCode_t CORBA_RTCUtil::connect_multi	(	const std::string &	name,
		const coil::Properties &	prop,
		const RTC::PortService_ptr	port,
		RTC::PortServiceList &	target_ports
	)

指定したポートと指定したリスト内のポート全てと接続する

◆ create_connector()

RTC::ConnectorProfile * CORBA_RTCUtil::create_connector	(	const std::string &	name,
		const coil::Properties &	prop_arg,
		const RTC::PortService_ptr	port0,
		const RTC::PortService_ptr	port1
	)

指定したポートを接続するためのコネクタプロファイルを取得

◆ deactivate()

RTC::ReturnCode_t CORBA_RTCUtil::deactivate	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

RTCを指定した実行コンテキストで非アクティベーションする

◆ disconnect()

RTC::ReturnCode_t CORBA_RTCUtil::disconnect ( const RTC::ConnectorProfile connector_prof )

対象のRTCの指定したポートのコネクタのIDのリストを取得

◆ disconnect_all() [1/2]

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_all ( const RTC::PortService_ptr port_ref )

対象のポートのコネクタを全て切断

◆ disconnect_all() [2/2]

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_all ( const std::string & port_name )

指定ポート名のポートのコネクタを全て切断

◆ disconnect_connector_id() [1/2]

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_id	(	const RTC::PortService_ptr	port_ref,
		const std::string &	conn_id
	)

対象のポートで指定したIDのコネクタを切断

◆ disconnect_connector_id() [2/2]

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_id	(	const std::string &	port_name,
		const std::string &	conn_id
	)

対象の名前のポートで指定したIDのコネクタを切断

◆ disconnect_connector_name() [1/2]

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_name	(	const RTC::PortService_ptr	port_ref,
		const std::string &	conn_name
	)

対象のポートで指定した名前のコネクタを切断

◆ disconnect_connector_name() [2/2]

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_connector_name	(	const std::string &	port_name,
		const std::string &	conn_name
	)

対象の名前のポートで指定した名前のコネクタを切断

◆ disconnect_name()

RTC::ReturnCode_t CORBA_RTCUtil::disconnect_name	(	const RTC::PortService_ptr	localport,
		const std::string &	othername
	)

対象ポートと接続しているポートで指定したポート名と一致した場合に切断

◆ get_active_configuration()

coil::Properties CORBA_RTCUtil::get_active_configuration ( const RTC::RTObject_ptr rtc )

アクティブなコンフィギュレーションセットをkey-valueで取得する

◆ get_active_configuration_name()

std::string CORBA_RTCUtil::get_active_configuration_name ( const RTC::RTObject_ptr rtc )

対象のRTCのアクティブなコンフィギュレーションセット名を取得する

◆ get_actual_ec()

RTC::ExecutionContext_ptr CORBA_RTCUtil::get_actual_ec	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

RTコンポーネントに関連付けした実行コンテキストから指定したIDの実行コンテキストを取得

◆ get_component_profile()

coil::Properties CORBA_RTCUtil::get_component_profile ( const RTC::RTObject_ptr rtc )

RTC操作ユーティリティー関数群

RTC基本操作系 get_profile() is_existing() is_alive_in_default_ec()
ECおよび状態操作系 get_actual_ec() get_ec_id() activate() deactivate() reset() get_state() is_in_inactive() is_in_active() is_in_error() get_default_rate() set_default_rate() get_current_rate() set_current_rate() add_rtc_to_default_ec() remove_rtc_to_default_ec() get_participants_rtc()
ポート操作系 get_port_names() get_inport_names() get_outport_names() get_svcport_names() get_port_by_name() get_connector_names(RTObject_ptr) get_connector_ids() create_connector() already_connected() connect() connect_by_name() disconnect() disconnect_by_connector_name() disconnect_by_connector_id() disconnect_by_port_name()
コンフィギュレーション系 get_configuration() get_parameter_by_key() get_current_configuration_name() get_active_configuration() set_configuration()

Getting component profile This is an example obtained properties from a RTC.

implementation_id: ConsoleOut
type_name: ConsoleOut
description: Console output component
version: 1.0
vendor: Noriaki Ando, AIST
category: example
activity_type: DataFlowComponent
max_instance: 10
language: C++
lang_type: compile
conf:
instance_name: ConsoleOut1
sdo
- service
  - provider
    - enabled_services:
    - available_services:
  - consumer
    - enabled_services:
    - available_services:
config
- version: 1.1.1
openrtm
- name: OpenRTM-aist-1.1.1
- version: 1.1.1
os
- name: Linux
- release: 3.13.0-24-generic
- version: #46-Ubuntu SMP Thu Apr 10 19:11:08 UTC 2014
- arch: x86_64
- hostname: ubuntu1404
corba
- endpoint:
- id: omniORB
exec_cxt
- periodic
  - type: PeriodicExecutionContext
  - rate: 1000
- sync_transition: YES
- transition_timeout: 0.5
logger
- enable: YES
- log_level: PARANOID
naming
- enable: YES
- type: corba
- formats: h.host_cxt/n.rtc
- names: ubuntu1404.host_cxt/ConsoleOut1.rtc
port
- inport
  - in
    - buffer
      - read
        
        empty_policy: block
        
        timeout: 2.0
      - write
        
        full_policy: overwrite
        
        timeout: 2.0
    - subscribe_topic: TimedLong
config_file: consout.conf

コンポーネントのプロパティ取得

引数

rtc RTコンポーネント

戻り値: コンポーネントのプロパティ

◆ get_configuration()

coil::Properties CORBA_RTCUtil::get_configuration	(	const RTC::RTObject_ptr	rtc,
		const std::string &	conf_name
	)

対象RTCの指定した名前のコンフィギュレーションセットをkey-valueで取得

◆ get_connector_ids() [1/2]

coil::vstring CORBA_RTCUtil::get_connector_ids ( const RTC::PortService_ptr port )

指定したポートの保持しているコネクタのIDのリストを取得

◆ get_connector_ids() [2/2]

coil::vstring CORBA_RTCUtil::get_connector_ids	(	const RTC::RTObject_ptr	rtc,
		const std::string &	port_name
	)

対象のRTCの指定したポートのコネクタのIDのリストを取得

◆ get_connector_names() [1/2]

coil::vstring CORBA_RTCUtil::get_connector_names ( const RTC::PortService_ptr port )

指定したポートの保持しているコネクタの名前のリストを取得

◆ get_connector_names() [2/2]

coil::vstring CORBA_RTCUtil::get_connector_names	(	const RTC::RTObject_ptr	rtc,
		const std::string &	port_name
	)

対象のRTCの指定したポートのコネクタの名前のリストを取得

◆ get_current_rate()

CORBA::Double CORBA_RTCUtil::get_current_rate	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id
	)

RTCの指定IDの実行コンテキストの周期を取得

◆ get_default_rate()

CORBA::Double CORBA_RTCUtil::get_default_rate ( const RTC::RTObject_ptr rtc )

RTCのデフォルトの実行コンテキストの実行周期を取得する

◆ get_ec_id()

RTC::UniqueId CORBA_RTCUtil::get_ec_id	(	const RTC::RTObject_ptr	rtc,
		const RTC::ExecutionContext_ptr	ec
	)

対象のRTコンポーネントから指定した実行コンテキストのIDを取得する

◆ get_inport_names()

coil::vstring CORBA_RTCUtil::get_inport_names ( const RTC::RTObject_ptr rtc )

指定したRTCの保持するインポートの名前を取得

◆ get_outport_names()

coil::vstring CORBA_RTCUtil::get_outport_names ( const RTC::RTObject_ptr rtc )

指定したRTCの保持するアウトポートの名前を取得

◆ get_parameter_by_key()

std::string CORBA_RTCUtil::get_parameter_by_key	(	const RTC::RTObject_ptr	rtc,
		const std::string &	confset_name,
		const std::string &	value_name
	)

指定したコンフィギュレーションセット名、パラメータ名のコンフィギュレーションパラメータを取得

◆ get_participants_rtc()

RTC::RTCList CORBA_RTCUtil::get_participants_rtc ( const RTC::RTObject_ptr rtc )

RTCのデフォルトの実行コンテキストに参加しているRTCのリストを取得する実行コンテキストがnilの場合は空のリストを返す

◆ get_port_by_name()

RTC::PortService_ptr CORBA_RTCUtil::get_port_by_name	(	const RTC::RTObject_ptr	rtc,
		const std::string &	name
	)

対象のRTCから指定した名前のポートを取得

◆ get_port_by_url()

RTC::PortService_ptr CORBA_RTCUtil::get_port_by_url ( const std::string & port_name )

指定した名前のポートを取得

◆ get_port_names()

coil::vstring CORBA_RTCUtil::get_port_names ( const RTC::RTObject_ptr rtc )

指定したRTCの保持するポートの名前を取得

◆ get_state()

bool CORBA_RTCUtil::get_state	(	RTC::LifeCycleState &	state,
		const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

対象のRTコンポーネントの指定した実行コンテキストでの状態を取得

◆ get_svcport_names()

coil::vstring CORBA_RTCUtil::get_svcport_names ( const RTC::RTObject_ptr rtc )

指定したRTCの保持するサービスポートの名前を取得

◆ is_alive_in_default_ec()

bool CORBA_RTCUtil::is_alive_in_default_ec ( const RTC::RTObject_ptr rtc )

RTCがデフォルトの実行コンテキストでalive状態かを判定する

◆ is_existing()

bool CORBA_RTCUtil::is_existing ( const RTC::RTObject_ptr rtc )

コンポーネントのオブジェクトリファレンスが存在しているかを判定

◆ is_in_active()

bool CORBA_RTCUtil::is_in_active	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

対象のRTコンポーネントの指定したECでACTIVE状態かどうか判定

◆ is_in_error()

bool CORBA_RTCUtil::is_in_error	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

対象のRTコンポーネントの指定したECでERROR状態かどうか判定

◆ is_in_inactive()

bool CORBA_RTCUtil::is_in_inactive	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

対象のRTコンポーネントの指定したECでINACTIVE状態かどうか判定

◆ remove_rtc_to_default_ec()

RTC::ReturnCode_t CORBA_RTCUtil::remove_rtc_to_default_ec	(	const RTC::RTObject_ptr	localcomp,
		const RTC::RTObject_ptr	othercomp
	)

対象のRTCのデフォルトのECの指定のRTCへの関連付けを解除する

◆ reset()

RTC::ReturnCode_t CORBA_RTCUtil::reset	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id = `0`
	)

RTCを指定した実行コンテキストでリセットする

◆ set_active_configuration()

bool CORBA_RTCUtil::set_active_configuration	(	const RTC::RTObject_ptr	rtc,
		const std::string &	value_name,
		const std::string &	value
	)

アクティブなコンフィギュレーションセットのパラメータを設定

◆ set_configuration()

bool CORBA_RTCUtil::set_configuration	(	const RTC::RTObject_ptr	rtc,
		const std::string &	confset_name,
		const std::string &	value_name,
		const std::string &	value
	)

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

◆ set_configuration_parameter()

bool CORBA_RTCUtil::set_configuration_parameter	(	SDOPackage::Configuration_ptr	conf,
		SDOPackage::ConfigurationSet &	confset,
		const std::string &	value_name,
		const std::string &	value
	)

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

◆ set_current_rate()

RTC::ReturnCode_t CORBA_RTCUtil::set_current_rate	(	const RTC::RTObject_ptr	rtc,
		const RTC::UniqueId	ec_id,
		const CORBA::Double	rate
	)

RTCの指定IDの実行コンテキストの周期を設定

◆ set_default_rate()

RTC::ReturnCode_t CORBA_RTCUtil::set_default_rate	(	const RTC::RTObject_ptr	rtc,
		CORBA::Double	rate
	)

RTCのデフォルトの実行コンテキストの実行周期を設定する

クラス

関数