クラス
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)
	コンフィギュレーションパラメータの設定

関数詳解

◆ activate()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: RTC、ECのオブジェクトリファレンスがnilの場合は BAD_PARAMETERを返すnilではない場合はactivate_component関数の戻り値を返す。RTC_OKの場合はアクティベーションが成功

◆ add_rtc_to_default_ec()

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

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

引数

localcomp	対象のRTコンポーネント
othercomp	実行コンテキストに関連付けるRTコンポーネント

戻り値: ecの取得に失敗した場合はBAD_PARAMETERを返すそうでない場合はaddComponent関数の戻り値を返す。RTC_OKで接続成功。

◆ already_connected()

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

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

引数

port0	対象のポート1
port1	対象のポート2

戻り値: True: 接続済み、False: 未接続

◆ connect()

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

戻り値: ポートのオブジェクトリファレンスがnilの場合はBAD_PARAMETERを返す nilではない場合はport0.connect関数の戻り値を返す。RTC_OKの場合は接続が成功

◆ connect_by_name()

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、ポートがnilの場合はBAD_PARAMETERを返す。 nilではない場合はport0.connect関数の戻り値を返す。RTC_OKの場合は接続が成功

◆ connect_multi()

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_OKを返す。 connect関数がRTC_OK以外を返した場合はBAD_PARAMETERを返す。

◆ create_connector()

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

戻り値: コネクタプロファイル

◆ deactivate()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: RTC、ECのオブジェクトリファレンスがnilの場合は BAD_PARAMETERを返すnilではない場合はdeactivate_component関数の戻り値を返す。RTC_OKの場合は非アクティベーションが成功

◆ disconnect()

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

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

引数

port	RTコンポーネント
port_name	ポート名

戻り値: コネクタのIDのリスト

◆ disconnect_all() [1/2]

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

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

引数

port_name ポート名

戻り値: portが存在しない場合はBAD_PARAMETERを返す切断できた場合はRTC_OKを返す

◆ disconnect_all() [2/2]

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

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

引数

port_ref ポートのオブジェクトリファレンス

戻り値: portが存在しない場合はBAD_PARAMETERを返す切断できた場合はRTC_OKを返す

◆ disconnect_connector_id() [1/2]

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

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

引数

port	対象のポート
name	コネクタID

戻り値: portが存在しない場合はBAD_PARAMETERを返す nilではない場合はdisconnect関数の戻り値を返す。RTC_OKの場合は切断が成功

◆ disconnect_connector_id() [2/2]

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

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

引数

port	対象のポート
name	コネクタID

戻り値: portが存在しない場合はBAD_PARAMETERを返す nilではない場合はdisconnect関数の戻り値を返す。RTC_OKの場合は切断が成功

◆ disconnect_connector_name() [1/2]

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

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

引数

port_name	対象のポート名
conn_name	コネクタ名

戻り値: portが存在しない場合はBAD_PARAMETERを返す nilではない場合はdisconnect関数の戻り値を返す。RTC_OKの場合は切断が成功

◆ disconnect_connector_name() [2/2]

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

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

引数

port_ref	対象のポート
conn_name	コネクタ名

戻り値: portがnilの場合はBAD_PARAMETERを返す nilではない場合はdisconnect関数の戻り値を返す。RTC_OKの場合は切断が成功

◆ disconnect_name()

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

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

引数

localport	対象のポート
othername	接続しているポート名

戻り値: ポートがnilの場合、localportの名前とothernameが一致する場合、接続しているポートの名前でothernameと一致するものがない場合にBAD_PARAMETERを返す上記の条件に当てはまらない場合はdisconnect関数の戻り値を返す。RTC_OKの場合は切断が成功

◆ get_active_configuration()

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

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

引数

rtc	対象のRTコンポーネント

戻り値: アクティブなコンフィギュレーションセット

◆ get_active_configuration_name()

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

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

引数

rtc RTコンポーネント

戻り値: コンフィギュレーションセット名コンフィギュレーションの取得に失敗した場合は空の文字列を返す

◆ get_actual_ec()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: 実行コンテキストのオブジェクトリファレンス

◆ get_component_profile()

coil::Properties CORBA_RTCUtil::get_component_profile ( 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	(	RTC::RTObject_ptr	rtc,
		const std::string &	conf_name )

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

引数

rtc	対象のRTコンポーネント
conf_name	コンフィギュレーションセット名

戻り値: コンフィギュレーションセット

◆ get_connector_ids() [1/2]

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

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

引数

port 対象のポート

戻り値: コネクタのIDのリスト

◆ get_connector_ids() [2/2]

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

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

引数

port	RTコンポーネント
port_name	ポート名

戻り値: コネクタのIDのリスト

◆ get_connector_names() [1/2]

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

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

引数

port 対象のポート

戻り値: コネクタ名のリスト

◆ get_connector_names() [2/2]

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

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

引数

rtc	対象のRTコンポーネント
port_name	ポート名

戻り値: コネクタ名のリスト

◆ get_current_rate()

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

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

引数

rtc	RTコンポーネント
ec_id	指定の実行コンテキストのID

戻り値: 実行周期

◆ get_default_rate()

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

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

引数

rtc RTコンポーネント

戻り値: 実行周期

◆ get_ec_id()

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

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

引数

rtc	RTコンポーネント
ec	実行コンテキスト

戻り値: 実行コンテキストのID 指定した実行コンテキストがRTコンポーネントに関連付けられていなかった場合は-1を返す

◆ get_inport_names()

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

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

引数

rtc	対象のRTコンポーネント

戻り値: ポート名のリスト

◆ get_outport_names()

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

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

引数

rtc	対象のRTコンポーネント

戻り値: ポート名のリスト

◆ get_parameter_by_key()

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	パラメータ名

戻り値: パラメータ

◆ get_participants_rtc()

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

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

引数

rtc	対象のRTコンポーネント

戻り値: RTCのリスト

◆ get_port_by_name()

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

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

引数

rtc	RTコンポーネント
port_name	ポート名

戻り値: ポート

◆ get_port_by_url()

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

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

引数

port_name ポート名

戻り値: ポートのオブジェクトリファレンス portが存在しない場合はnilを返す

◆ get_port_names()

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

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

引数

rtc	対象のRTコンポーネント

戻り値: ポート名のリスト

◆ get_state()

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

戻り値: rtc、ecがnilの場合はFalseを返す。 nilではない場合はstateに状態を代入してTrueを返す。

◆ get_svcport_names()

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

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

引数

rtc	対象のRTコンポーネント

戻り値: ポート名のリスト

◆ is_alive_in_default_ec()

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

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

引数

rtc RTコンポーネント

戻り値: True:alive状態

◆ is_existing()

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

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

引数

rtc RTコンポーネント

戻り値: True:生存、False:終了済み

◆ is_in_active()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: ACTIVE状態の時はTrue、それ以外はFalse rtc、ecがnilの場合もFalseを返す

◆ is_in_error()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: ERROR状態の時はTrue、それ以外はFalse rtc、ecがnilの場合もFalseを返す

◆ is_in_inactive()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: INACTIVE状態の時はTrue、それ以外はFalse rtc、ecがnilの場合もFalseを返す

◆ remove_rtc_to_default_ec()

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コンポーネント

戻り値: ecの取得に失敗した場合はBAD_PARAMETERを返すそうでない場合はremoveComponent関数の戻り値を返す。RTC_OKで解除成功。

◆ reset()

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

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

引数

rtc	対象のRTコンポーネント
ec_id	実行コンテキストのID

戻り値: RTC、ECのオブジェクトリファレンスがnilの場合は BAD_PARAMETERを返すnilではない場合はreset_component関数の戻り値を返す。RTC_OKの場合はリセットが成功

◆ set_active_configuration()

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

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

引数

rtc	対象のRTコンポーネント
value_name	パラメータ名
value	パラメータ

戻り値: True:設定に成功、False:設定に失敗

◆ set_configuration()

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	パラメータ

戻り値: True:設定に成功、False:設定に失敗

◆ 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 )

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

引数

conf	コンフィギュレーション
confset	コンフィギュレーションセット
value_name	パラメータ名
value	パラメータ

戻り値: True:設定に成功、False:設定に失敗

◆ set_current_rate()

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	実行周期

戻り値: set_rate関数の戻り値を返す。 RTC_OKで設定が成功

◆ set_default_rate()

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

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

引数

rtc	RTコンポーネント
rate	実行周期

戻り値: set_rate関数の戻り値を返す。 RTC_OKで設定が成功

クラス

関数

関数詳解

◆ activate()

◆ add_rtc_to_default_ec()

◆ already_connected()

◆ connect()

◆ connect_by_name()

◆ connect_multi()

◆ create_connector()

◆ deactivate()

◆ disconnect()

◆ disconnect_all() [1/2]

◆ disconnect_all() [2/2]

◆ disconnect_connector_id() [1/2]

◆ disconnect_connector_id() [2/2]

◆ disconnect_connector_name() [1/2]

◆ disconnect_connector_name() [2/2]

◆ disconnect_name()

◆ get_active_configuration()

◆ get_active_configuration_name()

◆ get_actual_ec()

◆ get_component_profile()

◆ get_configuration()

◆ get_connector_ids() [1/2]

◆ get_connector_ids() [2/2]

◆ get_connector_names() [1/2]

◆ get_connector_names() [2/2]

◆ get_current_rate()

◆ get_default_rate()

◆ get_ec_id()

◆ get_inport_names()

◆ get_outport_names()

◆ get_parameter_by_key()

◆ get_participants_rtc()

◆ get_port_by_name()

◆ get_port_by_url()

◆ get_port_names()

◆ get_state()

◆ get_svcport_names()

◆ is_alive_in_default_ec()

◆ is_existing()

◆ is_in_active()

◆ is_in_error()

◆ is_in_inactive()

◆ remove_rtc_to_default_ec()

◆ reset()

◆ set_active_configuration()

◆ set_configuration()

◆ set_configuration_parameter()

◆ set_current_rate()

◆ set_default_rate()