rtsprofile.port_connectors.ServicePortConnector Class Reference

ServicePortConnector object. More...

Inheritance diagram for rtsprofile.port_connectors.ServicePortConnector:

Public Member Functions
def	__init__ (self, connector_id='', name='', trans_method='', source_service_port=TargetPort(), target_service_port=TargetPort(), comment='', visible=True)
def	__str__ (self)
def	comment (self)
def	comment (self, comment)
def	connector_id (self)
def	connector_id (self, connector_id)
def	name (self)
def	name (self, name)
def	parse_xml_node (self, node)
def	parse_yaml (self, y)
def	properties (self)
def	properties (self, properties)
def	save_xml (self, doc, element)
def	source_service_port (self)
def	source_service_port (self, source_service_port)
def	target_service_port (self)
def	target_service_port (self, target_service_port)
def	to_dict (self)
def	trans_method (self)
def	trans_method (self, trans_method)
def	visible (self)
def	visible (self, 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 454 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.

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

Definition at line 607 of file port_connectors.py.

Member Data Documentation

rtsprofile.port_connectors.ServicePortConnector._comment

private

Definition at line 492 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._connector_id

private

Definition at line 475 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._name

private

Definition at line 478 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._properties

private

Definition at line 496 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._source_service_port

private

Definition at line 485 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._target_service_port

private

Definition at line 489 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._trans_method

private

Definition at line 481 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector._visible

private

Definition at line 495 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.comment

Definition at line 641 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.connector_id

Definition at line 634 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.name

Definition at line 635 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.source_service_port

Definition at line 651 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.target_service_port

Definition at line 655 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.trans_method

Definition at line 637 of file port_connectors.py.

rtsprofile.port_connectors.ServicePortConnector.visible

Definition at line 645 of file port_connectors.py.

---

The documentation for this class was generated from the following file:

• port_connectors.py