C:/docs/OpenRTM-aist-Python/OpenRTM_aist/CORBA_RTCUtil.py File Reference

CORBA RTC utility. More...

Classes
class	OpenRTM_aist.CORBA_RTCUtil.find_port

Functions
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)
def	OpenRTM_aist.CORBA_RTCUtil.get_actual_ec (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.get_ec_id (rtc, ec)
def	OpenRTM_aist.CORBA_RTCUtil.activate (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.deactivate (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.reset (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.get_state (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.is_in_inactive (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.is_in_active (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.is_in_error (rtc, ec_id=0)
def	OpenRTM_aist.CORBA_RTCUtil.get_default_rate (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.set_default_rate (rtc, rate)
def	OpenRTM_aist.CORBA_RTCUtil.get_current_rate (rtc, ec_id)
def	OpenRTM_aist.CORBA_RTCUtil.set_current_rate (rtc, ec_id, rate)
def	OpenRTM_aist.CORBA_RTCUtil.add_rtc_to_default_ec (localcomp, othercomp)
def	OpenRTM_aist.CORBA_RTCUtil.remove_rtc_to_default_ec (localcomp, othercomp)
def	OpenRTM_aist.CORBA_RTCUtil.get_participants_rtc (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.get_port_names (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.get_inport_names (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.get_outport_names (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.get_svcport_names (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.get_port_by_name (rtc, port_name)
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_names_by_portref (port)
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_names (rtc, port_name)
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_ids_by_portref (port)
def	OpenRTM_aist.CORBA_RTCUtil.get_connector_ids (rtc, port_name)
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)
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)
def	OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_id (port_name, conn_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)
def	OpenRTM_aist.CORBA_RTCUtil.get_parameter_by_key (rtc, confset_name, value_name)
def	OpenRTM_aist.CORBA_RTCUtil.get_active_configuration_name (rtc)
def	OpenRTM_aist.CORBA_RTCUtil.get_active_configuration (rtc)
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)

Detailed Description

CORBA RTC utility.

Date

Date

2016/01/08

Author

Nobuhiko Miyamoto

Function Documentation

activate()

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

Parameters

rtc
ec_id

Returns

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

add_rtc_to_default_ec()

def OpenRTM_aist.CORBA_RTCUtil.add_rtc_to_default_ec	(		localcomp,
			othercomp
	)

Parameters

iline 491

already_connected()

def OpenRTM_aist.CORBA_RTCUtil.already_connected	(		localport,
			otherport
	)

Parameters

name
prop_arg
port0
port1

Returns

connect()

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

Parameters

name
prop
port0
port1

Returns

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

connect_by_name()

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

Parameters

name
prop_arg
port0
port1

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)

connect_multi()

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

Parameters

name
prop
port0
port1

Returns

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

create_connector()

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

Parameters

name
prop_arg
port0
port1

Returns

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

deactivate()

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

Parameters

rtc
ec_id

Returns

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

disconnect()

def OpenRTM_aist.CORBA_RTCUtil.disconnect

(

connector_prof

)

Parameters

connector_prof

Returns

disconnect_all_by_name()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_all_by_name

(

port_name

)

Parameters

port

Returns

disconnect_all_by_ref()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_all_by_ref

(

port_ref

)

Parameters

port

Returns

disconnect_by_port_name()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_port_name	(		localport,
			othername
	)

Parameters

iline 1315

disconnect_by_portname_connector_id()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_id	(		port_name,
			conn_id
	)

Parameters

port_name
name

Returns

disconnect_by_portname_connector_name()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portname_connector_name	(		port_name,
			conn_name
	)

Parameters

iline 1156

disconnect_by_portref_connector_id()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portref_connector_id	(		port_ref,
			conn_id
	)

Parameters

iline 1186

disconnect_by_portref_connector_name()

def OpenRTM_aist.CORBA_RTCUtil.disconnect_by_portref_connector_name	(		port_ref,
			conn_name
	)

Parameters

port_ref
conn_name

Returns

get_active_configuration()

def OpenRTM_aist.CORBA_RTCUtil.get_active_configuration

(

rtc

)

Parameters

rtc

Returns

get_active_configuration_name()

def OpenRTM_aist.CORBA_RTCUtil.get_active_configuration_name

(

rtc

)

Parameters

rtc

Returns

get_actual_ec()

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

Parameters

rtc
ec_id

Returns

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

get_component_profile()

def OpenRTM_aist.CORBA_RTCUtil.get_component_profile

(

rtc

)

Parameters

rtc

Returns

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

get_configuration()

def OpenRTM_aist.CORBA_RTCUtil.get_configuration	(		rtc,
			conf_name
	)

Parameters

rtc
conf_name

Returns

get_connector_ids()

def OpenRTM_aist.CORBA_RTCUtil.get_connector_ids	(		rtc,
			port_name
	)

Parameters

rtc
port_name

Returns

get_connector_ids_by_portref()

def OpenRTM_aist.CORBA_RTCUtil.get_connector_ids_by_portref

(

port

)

Parameters

port

Returns

get_connector_names()

def OpenRTM_aist.CORBA_RTCUtil.get_connector_names	(		rtc,
			port_name
	)

Parameters

rtc
port_name

Returns

get_connector_names_by_portref()

def OpenRTM_aist.CORBA_RTCUtil.get_connector_names_by_portref

(

port

)

Parameters

port

Returns

get_current_rate()

def OpenRTM_aist.CORBA_RTCUtil.get_current_rate	(		rtc,
			ec_id
	)

Parameters

ec

Returns

get_default_rate()

def OpenRTM_aist.CORBA_RTCUtil.get_default_rate

(

rtc

)

Parameters

ec

Returns

get_ec_id()

def OpenRTM_aist.CORBA_RTCUtil.get_ec_id	(		rtc,
			ec
	)

Parameters

iline 151

get_inport_names()

def OpenRTM_aist.CORBA_RTCUtil.get_inport_names

(

rtc

)

Parameters

rtc

Returns

get_outport_names()

def OpenRTM_aist.CORBA_RTCUtil.get_outport_names

(

rtc

)

Parameters

rtc

Returns

get_parameter_by_key()

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

Parameters

rtc
confset_name
value_name
ret

Returns

get_participants_rtc()

def OpenRTM_aist.CORBA_RTCUtil.get_participants_rtc

(

rtc

)

Parameters

ec

Returns

get_port_by_name()

def OpenRTM_aist.CORBA_RTCUtil.get_port_by_name	(		rtc,
			port_name
	)

Parameters

rtc
port_name

Returns

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

get_port_by_url()

def OpenRTM_aist.CORBA_RTCUtil.get_port_by_url

(

port_name

)

Parameters

port_name

Returns

get_port_names()

def OpenRTM_aist.CORBA_RTCUtil.get_port_names

(

rtc

)

Parameters

rtc

Returns

get_state()

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

Parameters

rtc
ec_id

Returns

get_svcport_names()

def OpenRTM_aist.CORBA_RTCUtil.get_svcport_names

(

rtc

)

Parameters

rtc

Returns

is_alive_in_default_ec()

def OpenRTM_aist.CORBA_RTCUtil.is_alive_in_default_ec

(

rtc

)

Parameters

iline 84

is_existing()

def OpenRTM_aist.CORBA_RTCUtil.is_existing

(

rtc

)

Parameters

rtc

RTコンポーネント

Returns

is_in_active()

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

Parameters

rtc
ec_id

Returns

is_in_error()

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

Parameters

rtc
ec_id

Returns

is_in_inactive()

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

Parameters

rtc
ec_id

Returns

remove_rtc_to_default_ec()

def OpenRTM_aist.CORBA_RTCUtil.remove_rtc_to_default_ec	(		localcomp,
			othercomp
	)

Parameters

iline 517

reset()

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

Parameters

rtc
ec_id

Returns

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

set_active_configuration()

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

Parameters

rtc
confset_name
value_name
value

Returns

set_configuration()

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

Parameters

rtc
confset_name
value_name
value

Returns

set_configuration_parameter()

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

Parameters

conf
confset
value_name
value

Returns

set_current_rate()

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

Parameters

iline 467

set_default_rate()

def OpenRTM_aist.CORBA_RTCUtil.set_default_rate	(		rtc,
			rate
	)

Parameters

ec