Class that represents an operator input port. More...
Inheritance diagram for streams.OperatorInputPort:
[legend]
Classes |
|
| class | ImportType |
Public Member Functions |
|
| def | isImportedPort (self) |
| Check if this is an imported port. More... |
|
| def | getImportType (self) |
| Get the import type for the port. More... |
|
| def | isConnectedToAPEInputPort (self) |
| Check if this input port is connected to a PE input port. More... |
|
| def | getPEInputPortIndex (self) |
| Get the PE input port index for this operator input port. More... |
|
| def | isControl (self) |
| Check if this input port is a control port. More... |
|
 Public Member Functions inherited from streams.OperatorPort |
|
| def | getIndex (self) |
| Get the port index. More... |
|
| def | getName (self) |
| Get the port name. More... |
|
| def | getTupleType (self) |
| Get the tuple type for the port. More... |
|
Detailed Description
Class that represents an operator input port.
Member Function Documentation
◆ isImportedPort()
| def streams.OperatorInputPort.isImportedPort | ( | self, | |
| bool | |||
| ) |
Check if this is an imported port.
- Returns
- true if the port is an imported port, false otherwise
◆ getImportType()
| def streams.OperatorInputPort.getImportType | ( | self, | |
| ImportType | |||
| ) |
Get the import type for the port.
- Returns
- import type for the port
◆ isConnectedToAPEInputPort()
| def streams.OperatorInputPort.isConnectedToAPEInputPort | ( | self, | |
| bool | |||
| ) |
Check if this input port is connected to a PE input port.
- Returns
- true if connected to a PE input port, false otherwise
◆ getPEInputPortIndex()
| def streams.OperatorInputPort.getPEInputPortIndex | ( | self, | |
| int | |||
| ) |
Get the PE input port index for this operator input port.
- Precondition
- isConnectedToAPEInputPort() == true
- Returns
- the PE input port index for the given operator input port index
- Exceptions
-
SPLRuntimeInvalidIndexException when the operator port does not have an associated PE port
◆ isControl()
| def streams.OperatorInputPort.isControl | ( | self, | |
| bool | |||
| ) |
Check if this input port is a control port.
- Returns
- true if is a control port, false otherwise
The documentation for this class was generated from the following file:
- streams/__init__.py