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

ServicePort 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

ServicePort object.

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

Definition at line 215 of file ports.py.


Constructor & Destructor Documentation

def rtsprofile.ports.ServicePort.__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 221 of file ports.py.


Member Function Documentation

Definition at line 243 of file ports.py.

Comment about the service port.

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

Part of the extended profile.

Definition at line 270 of file ports.py.

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

Definition at line 282 of file ports.py.

The name of this service port.

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

Definition at line 255 of file ports.py.

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

Definition at line 264 of file ports.py.

def rtsprofile.ports.ServicePort.parse_xml_node (   self,
  node 
)
Parse an xml.dom Node object representing a service port into this
object.

Definition at line 322 of file ports.py.

def rtsprofile.ports.ServicePort.parse_yaml (   self,
  y 
)
Parse a YAML specification of a service port into this object.

Definition at line 342 of file ports.py.

Miscellaneous properties.

Stores key/value pair properties.

Part of the extended profile.

Definition at line 306 of file ports.py.

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

Definition at line 317 of file ports.py.

def rtsprofile.ports.ServicePort.save_xml (   self,
  doc,
  element 
)
Save this service port into an xml.dom.Element object.

Definition at line 361 of file ports.py.

Save this service port into a dictionary.

Definition at line 375 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 288 of file ports.py.

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

Definition at line 300 of file ports.py.


Member Data Documentation

Definition at line 230 of file ports.py.

Definition at line 230 of file ports.py.

Definition at line 230 of file ports.py.

Definition at line 230 of file ports.py.

Definition at line 325 of file ports.py.

Definition at line 325 of file ports.py.

Definition at line 325 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