Class that represents an operator output port. More...
Inheritance diagram for streams.OperatorOutputPort:
[legend]
Classes |
|
| class | ExportType |
Public Member Functions |
|
| def | isExportedPort (self) |
| Check if this is an exported port. More... |
|
| def | getExportType (self) |
| Get the export type for the port. More... |
|
| def | hasStreamProperty |
| def | removeStreamProperty |
| def | isConnectedToAPEOutputPort (self) |
| Check if this output port is connected to a PE output port. More... |
|
| def | getPEOutputPortIndex (self) |
| Get the PE output port index for this operator output port. More... |
|
| def | isExceptionPort (self) |
| Check if this output port is an exception 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 output port.
Member Function Documentation
◆ isExportedPort()
| def streams.OperatorOutputPort.isExportedPort | ( | self, | |
| bool | |||
| ) |
Check if this is an exported port.
- Returns
- true if the port is an exported port, false otherwise
◆ getExportType()
| def streams.OperatorOutputPort.getExportType | ( | self, | |
| ExportType | |||
| ) |
Get the export type for the port.
- Returns
- export type for the port
◆ hasStreamProperty()
| def streams.OperatorOutputPort.hasStreamProperty | ( | self, | |
| sp | |||
| ) |
◆ removeStreamProperty()
| def streams.OperatorOutputPort.removeStreamProperty | ( | self, | |
| sp | |||
| ) |
◆ isConnectedToAPEOutputPort()
| def streams.OperatorOutputPort.isConnectedToAPEOutputPort | ( | self, | |
| bool | |||
| ) |
Check if this output port is connected to a PE output port.
- Returns
- true if connected to a PE output port, false otherwise
◆ getPEOutputPortIndex()
| def streams.OperatorOutputPort.getPEOutputPortIndex | ( | self, | |
| int | |||
| ) |
Get the PE output port index for this operator output port.
- Precondition
- isConnectedToAPEOutputPort() == true
- Returns
- the PE output port index for the given operator output port index
- Exceptions
-
SPLRuntimeInvalidIndexException when the operator port does not have an associated PE port
◆ isExceptionPort()
| def streams.OperatorOutputPort.isExceptionPort | ( | self, | |
| bool | |||
| ) |
Check if this output port is an exception port.
- Returns
- true if this port is an exception port, false otherwise
- Since
- IBM Streams® Version 4.3.1.1
The documentation for this class was generated from the following file:
- streams/__init__.py