DataPortConnector object. More...

Public Member Functions
def	__init__
def	__str__
def	comment
def	comment
def	connector_id
def	connector_id
def	data_flow_type
def	data_flow_type
def	data_type
def	data_type
def	interface_type
def	interface_type
def	name
def	name
def	parse_xml_node
def	parse_yaml
def	properties
def	properties
def	push_interval
def	push_interval
def	save_xml
def	source_data_port
def	source_data_port
def	subscription_type
def	subscription_type
def	target_data_port
def	target_data_port
def	to_dict
def	visible
def	visible
Public Attributes
	comment
	connector_id
	data_flow_type
	data_type
	interface_type
	name
	push_interval
	source_data_port
	subscription_type
	target_data_port
	visible
Private Attributes
	_comment
	_connector_id
	_data_flow_type
	_data_type
	_interface_type
	_name
	_properties
	_push_interval
	_source_data_port
	_subscription_type
	_target_data_port
	_visible

Detailed Description

DataPortConnector object.

Represents a connection between data ports.

Definition at line 38 of file port_connectors.py.

Constructor & Destructor Documentation

def rtsprofile.port_connectors.DataPortConnector.__init__	(	self,
		connector_id = `''`,
		name = `''`,
		data_type = `''`,
		interface_type = `''`,
		data_flow_type = `''`,
		subscription_type = `''`,
		push_interval = `0.0`,
		source_data_port = `TargetPort()`,
		target_data_port = `TargetPort()`,
		comment = `''`,
		visible = `True`
	)

Constructor.

@param connector_id ID of the connector.
@type connector_id str
@param name Name of the connector.
@type name str
@param data_type Data type that this connector transports.
@type data_type str
@param interface_type Interface type of the connected ports.
@type interface_type str
@param data_flow_type Type of data flow between the ports.
@type data_flow_type str
@param subscription_type Type of subscription between the ports.
@type subscription_type str
@param push_interval Rate at which data is sent between the ports.
@type push_interval float
@param source_data_port The source port in the connection.
@type source_data_port TargetPort
@param target_data_port The target port in the connection.
@type target_data_port TargetPort
@param comment A comment about the port connector.
@type comment str
@param visible If this connector is visible in graphical displays.
@type visible bool

Definition at line 41 of file port_connectors.py.

Member Function Documentation

def rtsprofile.port_connectors.DataPortConnector.__str__ ( self )

Definition at line 109 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.comment ( self )

Comment about the connector.

A brief comment about the connector. May or may not be displayed in
other tools. May be empty.

Part of the extended profile.

Definition at line 249 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.comment	(	self,
		comment
	)

Definition at line 261 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.connector_id ( self )

The ID of the connector used to distinguish it in the RT system.

Definition at line 127 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.connector_id	(	self,
		connector_id
	)

Definition at line 132 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.data_flow_type ( self )

Type of data flow between the ports.

As specified when the RT system is created. Dependent on what the RT
Middleware used to execute the RT system supports.

Definition at line 176 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.data_flow_type	(	self,
		data_flow_type
	)

Definition at line 186 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.data_type ( self )

Data type that this connector transports.

Definition at line 149 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.data_type	(	self,
		data_type
	)

Definition at line 154 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.interface_type ( self )

Interface type of the connection.

As specified when the RT system is created. Dependent on what the RT
Middleware used to execute the RT system supports.

Definition at line 160 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.interface_type	(	self,
		interface_type
	)

Definition at line 170 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.name ( self )

The name of the connector.

Definition at line 138 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.name	(	self,
		name
	)

Definition at line 143 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.parse_xml_node	(	self,
		node
	)

Parse an xml.dom Node object representing a data connector into this
object.

Definition at line 301 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.parse_yaml	(	self,
		y
	)

Parse a YAML specification of a data port connector into this
object.

Definition at line 343 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.properties ( self )

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 285 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.properties	(	self,
		properties
	)

Definition at line 296 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.push_interval ( self )

Rate at which data is sent between ports.

As specified when the RT system is created.

Definition at line 210 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.push_interval	(	self,
		push_interval
	)

Definition at line 219 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.save_xml	(	self,
		doc,
		element
	)

Save this data port into an xml.dom.Element object.

Definition at line 387 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.source_data_port ( self )

The source port in the connection.

Definition at line 225 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.source_data_port	(	self,
		source_data_port
	)

Definition at line 230 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.subscription_type ( self )

Type of the subscription between the ports.

As specified when the RT system is created. Only used when @ref
data_flow_type is set to PUSH. Dependent on what the RT Middleware used
to execute the RT system supports.

Definition at line 192 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.subscription_type	(	self,
		subscription_type
	)

Definition at line 203 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.target_data_port ( self )

The target port in the connection.

Definition at line 237 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.target_data_port	(	self,
		target_data_port
	)

Definition at line 242 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.to_dict ( self )

Save this data port connector into a dictionary.

Definition at line 419 of file port_connectors.py.

def rtsprofile.port_connectors.DataPortConnector.visible ( self )

Display the connector in graphical tools.

This value controls whether graphical tools will display this connector
or not.

Part of the extended profile.

Definition at line 267 of file port_connectors.py.