TargetPort object. More...
Inheritance diagram for rtsprofile.targets.TargetPort:
Public Member Functions | |
| def | __init__ (self, component_id='', instance_name='', port_name='') |
| def | __str__ (self) |
| def | parse_xml_node (self, node) |
| def | parse_yaml (self, y) |
| def | port_name (self) |
| def | port_name (self, port_name) |
| def | save_xml (self, doc, element) |
| def | to_dict (self) |
 Public Member Functions inherited from rtsprofile.targets.TargetComponent | |
| def | __init__ (self, component_id='', instance_name='') |
| def | __str__ (self) |
| def | component_id (self) |
| def | component_id (self, component_id) |
| def | instance_name (self) |
| def | instance_name (self, instance_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) |
Public Attributes | |
| port_name | |
| Public Attributes inherited from rtsprofile.targets.TargetComponent | |
| component_id | |
| instance_name | |
Private Attributes | |
| _port_name | |
Detailed Description
TargetPort object.
Stores enough information to uniquely identify a port on a component in the RT system. Used to specify target ports in connections.
Definition at line 178 of file targets.py.
Constructor & Destructor Documentation
| def rtsprofile.targets.TargetPort.__init__ | ( | self, | |
component_id = '', |
|||
instance_name = '', |
|||
port_name = '' |
|||
| ) |
Constructor. See also the @ref TargetComponent constructor. @param port_name The name of the target port. @type port_name str
Definition at line 184 of file targets.py.
Member Function Documentation
| def rtsprofile.targets.TargetPort.__str__ | ( | self | ) |
Definition at line 196 of file targets.py.
| def rtsprofile.targets.TargetPort.parse_xml_node | ( | self, | |
| node | |||
| ) |
Parse an xml.dom Node object representing a target port into this object.
Definition at line 211 of file targets.py.
| def rtsprofile.targets.TargetPort.parse_yaml | ( | self, | |
| y | |||
| ) |
Parse a YAML specification of a target port into this object.
Definition at line 220 of file targets.py.
| def rtsprofile.targets.TargetPort.port_name | ( | self | ) |
The ID of the target port.
Definition at line 201 of file targets.py.
| def rtsprofile.targets.TargetPort.port_name | ( | self, | |
| port_name | |||
| ) |
Definition at line 206 of file targets.py.
| def rtsprofile.targets.TargetPort.save_xml | ( | self, | |
| doc, | |||
| element | |||
| ) |
Save this target port into an xml.dom.Element object.
Definition at line 226 of file targets.py.
| def rtsprofile.targets.TargetPort.to_dict | ( | self | ) |
Save this target port into a dictionary.
Definition at line 231 of file targets.py.
Member Data Documentation
|
private |
Definition at line 194 of file targets.py.
| rtsprofile.targets.TargetPort.port_name |
Definition at line 217 of file targets.py.
The documentation for this class was generated from the following file: