DataPortConnector object.
More...
|
def | __init__ (self, connector_id='', name='', data_type='', interface_type='', data_flow_type='', subscription_type='', push_interval=0.0, source_data_port=TargetPort(), target_data_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 | data_flow_type (self) |
|
def | data_flow_type (self, data_flow_type) |
|
def | data_type (self) |
|
def | data_type (self, data_type) |
|
def | interface_type (self) |
|
def | interface_type (self, interface_type) |
|
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 | push_interval (self) |
|
def | push_interval (self, push_interval) |
|
def | save_xml (self, doc, element) |
|
def | source_data_port (self) |
|
def | source_data_port (self, source_data_port) |
|
def | subscription_type (self) |
|
def | subscription_type (self, subscription_type) |
|
def | target_data_port (self) |
|
def | target_data_port (self, target_data_port) |
|
def | to_dict (self) |
|
def | visible (self) |
|
def | visible (self, visible) |
|
DataPortConnector object.
Represents a connection between data ports.
Definition at line 38 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.__init__ |
( |
|
self, |
|
|
|
connector_id = '' , |
|
|
|
name = '' , |
|
|
|
data_type = '' , |
|
|
|
interface_type = '' , |
|
|
|
data_flow_type = '' , |
|
|
|
subscription_type = '' , |
|
|
|
push_interval = 0.0 , |
|
|
|
source_data_port = TargetPort() , |
|
|
|
target_data_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 data_type Data type that this connector transports.
@type data_type str
@param interface_type Interface type of the connected ports.
@type interface_type str
@param data_flow_type Type of data flow between the ports.
@type data_flow_type str
@param subscription_type Type of subscription between the ports.
@type subscription_type str
@param push_interval Rate at which data is sent between the ports.
@type push_interval float
@param source_data_port The source port in the connection.
@type source_data_port TargetPort
@param target_data_port The target port in the connection.
@type target_data_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 44 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.__str__ |
( |
|
self | ) |
|
def rtsprofile.port_connectors.DataPortConnector.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 249 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.comment |
( |
|
self, |
|
|
|
comment |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.connector_id |
( |
|
self | ) |
|
The ID of the connector used to distinguish it in the RT system.
Definition at line 127 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.connector_id |
( |
|
self, |
|
|
|
connector_id |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.data_flow_type |
( |
|
self | ) |
|
Type of data flow between 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 176 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.data_flow_type |
( |
|
self, |
|
|
|
data_flow_type |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.data_type |
( |
|
self | ) |
|
def rtsprofile.port_connectors.DataPortConnector.data_type |
( |
|
self, |
|
|
|
data_type |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.interface_type |
( |
|
self | ) |
|
Interface type of the connection.
As specified when the RT system is created. Dependent on what the RT
Middleware used to execute the RT system supports.
Definition at line 160 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.interface_type |
( |
|
self, |
|
|
|
interface_type |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.name |
( |
|
self | ) |
|
def rtsprofile.port_connectors.DataPortConnector.name |
( |
|
self, |
|
|
|
name |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.parse_xml_node |
( |
|
self, |
|
|
|
node |
|
) |
| |
Parse an xml.dom Node object representing a data connector into this
object.
Definition at line 301 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.parse_yaml |
( |
|
self, |
|
|
|
y |
|
) |
| |
Parse a YAML specification of a data port connector into this
object.
Definition at line 343 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.properties |
( |
|
self | ) |
|
Miscellaneous properties.
Stores key/value pair properties.
Part of the extended profile.
Definition at line 285 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.properties |
( |
|
self, |
|
|
|
properties |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.push_interval |
( |
|
self | ) |
|
Rate at which data is sent between ports.
As specified when the RT system is created.
Definition at line 210 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.push_interval |
( |
|
self, |
|
|
|
push_interval |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.save_xml |
( |
|
self, |
|
|
|
doc, |
|
|
|
element |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.source_data_port |
( |
|
self | ) |
|
def rtsprofile.port_connectors.DataPortConnector.source_data_port |
( |
|
self, |
|
|
|
source_data_port |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.subscription_type |
( |
|
self | ) |
|
Type of the subscription between the ports.
As specified when the RT system is created. Only used when @ref
data_flow_type is set to PUSH. Dependent on what the RT Middleware used
to execute the RT system supports.
Definition at line 192 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.subscription_type |
( |
|
self, |
|
|
|
subscription_type |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.target_data_port |
( |
|
self | ) |
|
def rtsprofile.port_connectors.DataPortConnector.target_data_port |
( |
|
self, |
|
|
|
target_data_port |
|
) |
| |
def rtsprofile.port_connectors.DataPortConnector.to_dict |
( |
|
self | ) |
|
def rtsprofile.port_connectors.DataPortConnector.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 267 of file port_connectors.py.
def rtsprofile.port_connectors.DataPortConnector.visible |
( |
|
self, |
|
|
|
visible |
|
) |
| |
rtsprofile.port_connectors.DataPortConnector._comment |
|
private |
rtsprofile.port_connectors.DataPortConnector._connector_id |
|
private |
rtsprofile.port_connectors.DataPortConnector._data_flow_type |
|
private |
rtsprofile.port_connectors.DataPortConnector._data_type |
|
private |
rtsprofile.port_connectors.DataPortConnector._interface_type |
|
private |
rtsprofile.port_connectors.DataPortConnector._name |
|
private |
rtsprofile.port_connectors.DataPortConnector._properties |
|
private |
rtsprofile.port_connectors.DataPortConnector._push_interval |
|
private |
rtsprofile.port_connectors.DataPortConnector._source_data_port |
|
private |
rtsprofile.port_connectors.DataPortConnector._subscription_type |
|
private |
rtsprofile.port_connectors.DataPortConnector._target_data_port |
|
private |
rtsprofile.port_connectors.DataPortConnector._visible |
|
private |
rtsprofile.port_connectors.DataPortConnector.comment |
rtsprofile.port_connectors.DataPortConnector.connector_id |
rtsprofile.port_connectors.DataPortConnector.data_flow_type |
rtsprofile.port_connectors.DataPortConnector.data_type |
rtsprofile.port_connectors.DataPortConnector.interface_type |
rtsprofile.port_connectors.DataPortConnector.name |
rtsprofile.port_connectors.DataPortConnector.push_interval |
rtsprofile.port_connectors.DataPortConnector.source_data_port |
rtsprofile.port_connectors.DataPortConnector.subscription_type |
rtsprofile.port_connectors.DataPortConnector.target_data_port |
rtsprofile.port_connectors.DataPortConnector.visible |
The documentation for this class was generated from the following file: