ServicePortConnector object. More...

Public Member Functions
def	__init__
def	__str__
def	comment
def	comment
def	connector_id
def	connector_id
def	name
def	name
def	parse_xml_node
def	parse_yaml
def	properties
def	properties
def	save_xml
def	source_service_port
def	source_service_port
def	target_service_port
def	target_service_port
def	to_dict
def	trans_method
def	trans_method
def	visible
def	visible
Public Attributes
	comment
	connector_id
	name
	source_service_port
	target_service_port
	trans_method
	visible
Private Attributes
	_comment
	_connector_id
	_name
	_properties
	_source_service_port
	_target_service_port
	_trans_method
	_visible

Detailed Description

ServicePortConnector object.

Represents a connection between service ports.

Definition at line 449 of file port_connectors.py.

Constructor & Destructor Documentation

def rtsprofile.port_connectors.ServicePortConnector.__init__	(	self,
		connector_id = `''`,
		name = `''`,
		trans_method = `''`,
		source_service_port = `TargetPort()`,
		target_service_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 trans_method Transport method used by the ports.
@type trans_method str
@param source_service_port The source port in the connection.
@type source_service_port TargetPort
@param target_service_port The target port in the connection.
@type target_service_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 452 of file port_connectors.py.

Member Function Documentation

def rtsprofile.port_connectors.ServicePortConnector.__str__ ( self )

Definition at line 499 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.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 577 of file port_connectors.py.

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

Definition at line 589 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.connector_id ( self )

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

Definition at line 515 of file port_connectors.py.

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

Definition at line 520 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.name ( self )

The name of the connector.

Definition at line 526 of file port_connectors.py.

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

Definition at line 531 of file port_connectors.py.

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

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

Definition at line 629 of file port_connectors.py.

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

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

Definition at line 663 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.properties ( self )

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 613 of file port_connectors.py.

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

Definition at line 624 of file port_connectors.py.

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

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

Definition at line 700 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.source_service_port ( self )

The source port in the connection.

Definition at line 553 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.source_service_port	(	self,
		source_service_port
	)

Definition at line 558 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.target_service_port ( self )

The target port in the connection.

Definition at line 565 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.target_service_port	(	self,
		target_service_port
	)

Definition at line 570 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.to_dict ( self )

Save this service port connector into a dictionary.

Definition at line 727 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.trans_method ( self )

Transport method used by 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 537 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.trans_method	(	self,
		trans_method
	)

Definition at line 547 of file port_connectors.py.

def rtsprofile.port_connectors.ServicePortConnector.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 595 of file port_connectors.py.