rtsprofile.ports.DataPort Class Reference

DataPort object. More...

Inheritance diagram for rtsprofile.ports.DataPort:

Public Member Functions
def	__init__ (self, name='', comment='', visible=True)
def	__str__ (self)
def	comment (self)
def	comment (self, comment)
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	to_dict (self)
def	visible (self)
def	visible (self, visible)

Public Attributes
	comment
	name
	visible

Private Attributes
	_comment
	_name
	_properties
	_visible

Detailed Description

DataPort object.

Represents a data port of a component, as specified in a
ConnectorProfile.

Definition at line 35 of file ports.py.

Constructor & Destructor Documentation

def rtsprofile.ports.DataPort.__init__	(		self,
			name = '',
			comment = '',
			visible = True
	)

Constructor.

@param name Name of the port.
@type name str
@param comment A comment about the port.
@type comment str
@param visible If this port is visible in graphical displays.
@type visible bool

Definition at line 41 of file ports.py.

Member Function Documentation

def rtsprofile.ports.DataPort.__str__

(

self

)

Definition at line 63 of file ports.py.

def rtsprofile.ports.DataPort.comment

(

self

)

Comment about the data port.

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

Part of the extended profile.

Definition at line 90 of file ports.py.

def rtsprofile.ports.DataPort.comment	(		self,
			comment
	)

Definition at line 102 of file ports.py.

def rtsprofile.ports.DataPort.name

(

self

)

The name of this data port.

This name is used in connector profiles to identify the port.

Definition at line 75 of file ports.py.

def rtsprofile.ports.DataPort.name	(		self,
			name
	)

Definition at line 84 of file ports.py.

def rtsprofile.ports.DataPort.parse_xml_node	(		self,
			node
	)

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

Definition at line 142 of file ports.py.

def rtsprofile.ports.DataPort.parse_yaml	(		self,
			y
	)

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

Definition at line 162 of file ports.py.

def rtsprofile.ports.DataPort.properties

(

self

)

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 126 of file ports.py.

def rtsprofile.ports.DataPort.properties	(		self,
			properties
	)

Definition at line 137 of file ports.py.

def rtsprofile.ports.DataPort.save_xml	(		self,
			doc,
			element
	)

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

Definition at line 181 of file ports.py.

def rtsprofile.ports.DataPort.to_dict

(

self

)

Save this data port into a dictionary.

Definition at line 195 of file ports.py.

def rtsprofile.ports.DataPort.visible

(

self

)

Display the port in graphical tools.

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

Part of the extended profile.

Definition at line 108 of file ports.py.

def rtsprofile.ports.DataPort.visible	(		self,
			visible
	)

Definition at line 120 of file ports.py.

Member Data Documentation

rtsprofile.ports.DataPort._comment

private

Definition at line 57 of file ports.py.

rtsprofile.ports.DataPort._name

private

Definition at line 54 of file ports.py.

rtsprofile.ports.DataPort._properties

private

Definition at line 61 of file ports.py.

rtsprofile.ports.DataPort._visible

private

Definition at line 60 of file ports.py.

rtsprofile.ports.DataPort.comment

Definition at line 149 of file ports.py.

rtsprofile.ports.DataPort.name

Definition at line 148 of file ports.py.

rtsprofile.ports.DataPort.visible

Definition at line 153 of file ports.py.

---

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

• ports.py