Public Member Functions | Public Attributes | Private Attributes
rtsprofile.ports.DataPort Class Reference

DataPort object. More...

List of all members.

Public Member Functions

def __init__
def __str__
def comment
def comment
def name
def name
def parse_xml_node
def parse_yaml
def properties
def properties
def save_xml
def to_dict
def visible
def 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

Definition at line 63 of file ports.py.

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.

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.

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.

Save this data port into a dictionary.

Definition at line 195 of file ports.py.

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

Definition at line 50 of file ports.py.

Definition at line 50 of file ports.py.

Definition at line 50 of file ports.py.

Definition at line 50 of file ports.py.

Definition at line 145 of file ports.py.

Definition at line 145 of file ports.py.

Definition at line 145 of file ports.py.


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


rtsprofile
Author(s): Geoffrey Biggs
autogenerated on Sun Mar 26 2017 03:39:43