/home/openrtm/git-src/OpenRTM-aist-Python/OpenRTM_aist/CORBA_RTCUtil.py ファイル

CORBA RTC utility. [詳解]

クラス
class	OpenRTM_aist.CORBA_RTCUtil.find_port
	ポートを名前から検索 [詳解]

関数
def	OpenRTM_aist.CORBA_RTCUtil.get_component_profile (rtc)
	コンポーネントのプロパティ取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.is_existing (rtc)
	コンポーネントのオブジェクトリファレンスが存在しているかを判定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.is_alive_in_default_ec (rtc)
	RTCがデフォルトの実行コンテキストでalive状態かを判定する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_actual_ec (rtc, ec_id=0)
	RTコンポーネントに関連付けした実行コンテキストから指定したIDの実行コンテキストを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_ec_id (rtc, ec)
	対象のRTコンポーネントから指定した実行コンテキストのIDを取得する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.activate (rtc, ec_id=0)
	RTCを指定した実行コンテキストでアクティベーションする [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.deactivate (rtc, ec_id=0)
	RTCを指定した実行コンテキストで非アクティベーションする [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.reset (rtc, ec_id=0)
	RTCを指定した実行コンテキストでリセットする [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_state (rtc, ec_id=0)
	対象のRTコンポーネントの指定した実行コンテキストでの状態を取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.is_in_inactive (rtc, ec_id=0)
	対象のRTコンポーネントの指定した実行コンテキストでINACTIVE状態かどうか判定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.is_in_active (rtc, ec_id=0)
	対象のRTコンポーネントの指定した実行コンテキストでACTIVE状態かどうか判定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.is_in_error (rtc, ec_id=0)
	対象のRTコンポーネントの指定した実行コンテキストでERROR状態かどうか判定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_default_rate (rtc)
	RTCのデフォルトの実行コンテキストの実行周期を取得する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.set_default_rate (rtc, rate)
	RTCのデフォルトの実行コンテキストの実行周期を設定する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_current_rate (rtc, ec_id)
	RTCの指定IDの実行コンテキストの周期を取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.set_current_rate (rtc, ec_id, rate)
	RTCの指定IDの実行コンテキストの周期を設定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.add_rtc_to_default_ec (localcomp, othercomp)
	対象のRTCのデフォルトの実行コンテキストに指定のRTCを関連付ける [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.remove_rtc_to_default_ec (localcomp, othercomp)
	対象のRTCのデフォルトの実行コンテキストの指定のRTCへの関連付けを解除する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_participants_rtc (rtc)
	RTCのデフォルトの実行コンテキストに参加しているRTCのリストを取得する 実行コンテキストがnilの場合は空のリストを返す [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_port_names (rtc)
	指定したRTCの保持するポートの名前を取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_inport_names (rtc)
	指定したRTCの保持するインポートの名前を取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_outport_names (rtc)
	指定したRTCの保持するアウトポートの名前を取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_svcport_names (rtc)
	指定したRTCの保持するサービスポートの名前を取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_port_by_name (rtc, port_name)
	対象のRTCから指定した名前のポートを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_names_by_portref (port)
	指定したポートの保持しているコネクタの名前のリストを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_names (rtc, port_name)
	対象のRTCの指定したポートのコネクタの名前のリストを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_ids_by_portref (port)
	指定したポートの保持しているコネクタのIDのリストを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_ids (rtc, port_name)
	対象のRTCの指定したポートのコネクタのIDのリストを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.create_connector (name, prop_arg, port0, port1)
	指定したポートを接続するためのコネクタプロファイルを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.already_connected (localport, otherport)
	指定したポート同士が接続されているかを判定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.connect (name, prop, port0, port1)
	指定したポートを接続する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.connect_multi (name, prop, port, target_ports)
	指定したポートと指定したリスト内のポート全てと接続する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.connect_by_name (name, prop, rtc0, port_name0, rtc1, port_name1)
	対象のRTCの指定した名前のポートを接続する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect (connector_prof)
	指定のコネクタを切断する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portref_connector_name (port_ref, conn_name)
	対象のポートで指定した名前のコネクタを切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_name (port_name, conn_name)
	対象の名前のポートで指定した名前のコネクタを切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portref_connector_id (port_ref, conn_id)
	対象のポートで指定したIDのコネクタを切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_id (port_name, conn_id)
	対象の名前のポートで指定したIDのコネクタを切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_all_by_ref (port_ref)
	対象のポートのコネクタを全て切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_all_by_name (port_name)
	指定ポート名のポートのコネクタを全て切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_port_by_url (port_name)
	指定した名前のポートを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_by_port_name (localport, othername)
	対象ポートと接続しているポートで指定したポート名と一致した場合に切断 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_configuration (rtc, conf_name)
	対象のRTコンポーネントの指定した名前のコンフィギュレーションセットをkey-valueで取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_parameter_by_key (rtc, confset_name, value_name)
	指定したコンフィギュレーションセット名、パラメータ名のコンフィギュレーションパラメータを取得 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_active_configuration_name (rtc)
	対象のRTCのアクティブなコンフィギュレーションセット名を取得する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.get_active_configuration (rtc)
	アクティブなコンフィギュレーションセットをkey-valueで取得する [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.set_configuration (rtc, confset_name, value_name, value)
	コンフィギュレーションパラメータを設定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.set_active_configuration (rtc, value_name, value)
	アクティブなコンフィギュレーションセットのパラメータを設定 [詳解]
def	OpenRTM_aist.CORBA_RTCUtil.set_configuration_parameter (conf, confset, value_name, value)
	コンフィギュレーションパラメータの設定 [詳解]

詳解

CORBA RTC utility.

日付

Date

2016/01/08

著者

Nobuhiko Miyamoto

関数詳解

def OpenRTM_aist.CORBA_RTCUtil.activate	(		rtc,
			ec_id = 0
	)

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

引数

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

戻り値

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

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

def OpenRTM_aist.CORBA_RTCUtil.add_rtc_to_default_ec	(		localcomp,
			othercomp
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.already_connected	(		localport,
			otherport
	)

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

引数

localport	対象のポート1
otherport	対象のポート2

戻り値

True: 接続済み、False: 未接続

def OpenRTM_aist.CORBA_RTCUtil.connect	(		name,
			prop,
			port0,
			port1
	)

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

引数

name	コネクタ名
prop	設定
port0	対象のポート1
port1	対象のポート2

戻り値

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

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

def OpenRTM_aist.CORBA_RTCUtil.connect_by_name	(		name,
			prop,
			rtc0,
			port_name0,
			rtc1,
			port_name1
	)

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

引数

name	コネクタ名
prop	設定
rtc0	対象のRTCコンポーネント1
portName0	対象のポート名1
rtc1	対象のRTCコンポーネント2
portName1	対象のRTCコンポーネント2

戻り値

RTC、ポートがnilの場合はBAD_PARAMETERを返す。 nilではない場合はport0.connect関数の戻り値を返す。RTC_OKの場合は接続が成功

RTC::ReturnCode_t connect_by_name(std::string name, coil::Properties prop,RTC::RTObject_ptr rtc0,const std::string port_name0,RTC::RTObject_ptr rtc1,const std::string port_name1)

def OpenRTM_aist.CORBA_RTCUtil.connect_multi	(		name,
			prop,
			port,
			target_ports
	)

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

引数

name	コネクタ名
prop	設定
port	対象のポート
target_ports	対象のポートのリスト

戻り値

全ての接続が成功した場合はRTC_OKを返す。 connect関数がRTC_OK以外を返した場合はBAD_PARAMETERを返す。

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

def OpenRTM_aist.CORBA_RTCUtil.create_connector	(		name,
			prop_arg,
			port0,
			port1
	)

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

引数

name	コネクタ名
prop_arg	設定
port0	対象のポート1
port1	対象のポート2

戻り値

コネクタプロファイル

RTC::ConnectorProfile_var create_connector(const std::string name,const coil::Properties prop_arg,const RTC::PortService_ptr port0,const RTC::PortService_ptr port1)

def OpenRTM_aist.CORBA_RTCUtil.deactivate	(		rtc,
			ec_id = 0
	)

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

引数

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

戻り値

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

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

def OpenRTM_aist.CORBA_RTCUtil.disconnect

(

connector_prof

)

指定のコネクタを切断する

引数

connector_prof

コネクタプロファイル

戻り値

コネクタプロファイルで保持しているポートのオブジェクトリファレンスがnilの場合はBAD_PARAMETERを返す nilではない場合はports[0].disconnect関数の戻り値を返す。RTC_OKの場合は切断が成功

def OpenRTM_aist.CORBA_RTCUtil.disconnect_all_by_name

(

port_name

)

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

引数

port_name

ポート名

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.disconnect_all_by_ref

(

port_ref

)

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

引数

port_ref

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

戻り値

portがnilの場合はBAD_PARAMETERを返す 切断できた場合はRTC_OKを返す

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_port_name	(		localport,
			othername
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_id	(		port_name,
			conn_id
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_name	(		port_name,
			conn_name
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portref_connector_id	(		port_ref,
			conn_id
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portref_connector_name	(		port_ref,
			conn_name
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.get_active_configuration

(

rtc

)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.get_active_configuration_name

(

rtc

)

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

引数

rtc

RTコンポーネント

戻り値

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

引数

def OpenRTM_aist.CORBA_RTCUtil.get_actual_ec	(		rtc,
			ec_id = 0
	)

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

引数

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

戻り値

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

RTC::ExecutionContext_var get_actual_ec(const RTC::RTObject_ptr rtc,RTC::UniqueId ec_id = 0)

def OpenRTM_aist.CORBA_RTCUtil.get_component_profile

(

rtc

)

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

引数

rtc

RTコンポーネント

戻り値

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

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

def OpenRTM_aist.CORBA_RTCUtil.get_configuration	(		rtc,
			conf_name
	)

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

引数

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

戻り値

コンフィギュレーションセット

def OpenRTM_aist.CORBA_RTCUtil.get_connector_ids	(		rtc,
			port_name
	)

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

引数

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

戻り値

コネクタのIDのリスト

def OpenRTM_aist.CORBA_RTCUtil.get_connector_ids_by_portref

(

port

)

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

引数

port

対象のポート

戻り値

コネクタのIDのリスト

def OpenRTM_aist.CORBA_RTCUtil.get_connector_names	(		rtc,
			port_name
	)

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

引数

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

戻り値

コネクタ名のリスト

def OpenRTM_aist.CORBA_RTCUtil.get_connector_names_by_portref

(

port

)

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

引数

port

対象のポート

戻り値

コネクタ名のリスト

def OpenRTM_aist.CORBA_RTCUtil.get_current_rate	(		rtc,
			ec_id
	)

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

引数

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

戻り値

実行周期

def OpenRTM_aist.CORBA_RTCUtil.get_default_rate

(

rtc

)

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

引数

rtc

RTコンポーネント

戻り値

実行周期

def OpenRTM_aist.CORBA_RTCUtil.get_ec_id	(		rtc,
			ec
	)

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

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.get_inport_names

(

rtc

)

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

引数

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

戻り値

ポート名のリスト

def OpenRTM_aist.CORBA_RTCUtil.get_outport_names

(

rtc

)

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

引数

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

戻り値

ポート名のリスト

def OpenRTM_aist.CORBA_RTCUtil.get_parameter_by_key	(		rtc,
			confset_name,
			value_name
	)

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

引数

rtc	RTコンポーネント
confset_name	コンフィギュレーションセット名
value_name	パラメータ名

戻り値

パラメータ

def OpenRTM_aist.CORBA_RTCUtil.get_participants_rtc

(

rtc

)

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

引数

rtc

RTコンポーネント

戻り値

RTCのリスト

def OpenRTM_aist.CORBA_RTCUtil.get_port_by_name	(		rtc,
			port_name
	)

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

引数

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

戻り値

ポート

RTC::PortService_var get_port_by_name(const RTC::RTObject_ptr rtc, std::string port_name)

def OpenRTM_aist.CORBA_RTCUtil.get_port_by_url

(

port_name

)

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

引数

port_name

ポート名

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.get_port_names

(

rtc

)

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

引数

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

戻り値

ポート名のリスト

def OpenRTM_aist.CORBA_RTCUtil.get_state	(		rtc,
			ec_id = 0
	)

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

引数

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

戻り値

1番目の戻り値としてrtc、ecがnilの場合はFalseを返し、それ以外の場合はTrueを返す。 2番目の戻り値として状態を返す。

def OpenRTM_aist.CORBA_RTCUtil.get_svcport_names

(

rtc

)

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

引数

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

戻り値

ポート名のリスト

def OpenRTM_aist.CORBA_RTCUtil.is_alive_in_default_ec

(

rtc

)

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

引数

rtc

RTコンポーネント

戻り値

True:alive状態

引数

def OpenRTM_aist.CORBA_RTCUtil.is_existing

(

rtc

)

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

引数

rtc

RTコンポーネント

戻り値

True:生存、False:終了済み

def OpenRTM_aist.CORBA_RTCUtil.is_in_active	(		rtc,
			ec_id = 0
	)

対象のRTコンポーネントの指定した実行コンテキストでACTIVE状態かどうか判定

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.is_in_error	(		rtc,
			ec_id = 0
	)

対象のRTコンポーネントの指定した実行コンテキストでERROR状態かどうか判定

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.is_in_inactive	(		rtc,
			ec_id = 0
	)

対象のRTコンポーネントの指定した実行コンテキストでINACTIVE状態かどうか判定

引数

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

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.remove_rtc_to_default_ec	(		localcomp,
			othercomp
	)

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

引数

localcomp	対象のRTコンポーネント
othercomp	実行コンテキストとの関連付けを解除するRTコンポーネント

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.reset	(		rtc,
			ec_id = 0
	)

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

引数

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

戻り値

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

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

def OpenRTM_aist.CORBA_RTCUtil.set_active_configuration	(		rtc,
			value_name,
			value
	)

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

引数

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

戻り値

True:設定に成功、False:設定に失敗

def OpenRTM_aist.CORBA_RTCUtil.set_configuration	(		rtc,
			confset_name,
			value_name,
			value
	)

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

引数

rtc	対象のRTコンポーネント
confset_name	コンフィギュレーションセット名
value_name	パラメータ名
value	パラメータ

戻り値

True:設定に成功、False:設定に失敗

def OpenRTM_aist.CORBA_RTCUtil.set_configuration_parameter	(		conf,
			confset,
			value_name,
			value
	)

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

引数

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

戻り値

True:設定に成功、False:設定に失敗

def OpenRTM_aist.CORBA_RTCUtil.set_current_rate	(		rtc,
			ec_id,
			rate
	)

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

引数

rtc	対象のRTコンポーネント
ec_id	指定の実行コンテキストのID
rate	実行周期

戻り値

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

def OpenRTM_aist.CORBA_RTCUtil.set_default_rate	(		rtc,
			rate
	)

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

引数

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

戻り値

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