Class that represents an operator output port. More...

#include <SPL/Runtime/Operator/Port/OperatorOutputPort.h>

Inheritance diagram for SPL::OperatorOutputPort:

[legend]

Public Types

enum ExportType { ByName, ByProperties, NotExported }

Export type enumeration. More...

Public Member Functions

virtual bool isExportedPort () const =0

virtual ExportType getExportType () const =0

virtual void getStreamProperties (StreamPropertyCollection &spc) const =0

virtual void getStreamProperties (StreamPropertyCollection &spc, std::vector< std::string > const &names) const =0

virtual void setStreamProperties (StreamPropertyCollection const &spc) const =0

virtual void addStreamProperties (StreamPropertyCollection const &spc) const =0

virtual void removeStreamProperties (std::vector< std::string > const &spc) const =0

virtual bool hasStreamProperty (std::string const &sp) const =0

virtual void getStreamProperty (StreamProperty &sp, std::string const &name) const =0

virtual void setStreamProperty (StreamProperty const &sp) const =0

virtual void addStreamProperty (StreamProperty const &sp) const =0

virtual void removeStreamProperty (std::string const &sp) const =0

virtual bool isConnectedToAPEOutputPort () const =0

virtual uint32_t getPEOutputPortIndex () const =0

Public Member Functions inherited from SPL::OperatorPort

virtual uint32_t getIndex () const =0

virtual std::string const & getName () const =0

virtual std::auto_ptr< Tuple > createTuple () const =0

virtual Meta::BaseType const & getTupleType () const =0

Detailed Description

Class that represents an operator output port.

Member Enumeration Documentation

enum SPL::OperatorOutputPort::ExportType

Export type enumeration.

Enumerator
ByName	Export by name.
ByProperties	Export by properties.
NotExported	Invalid (not exported)

Member Function Documentation

virtual bool SPL::OperatorOutputPort::isExportedPort ( ) const

pure virtual

Check if this is an exported port

Returns: true if the port is an exported port, false otherwise

virtual ExportType SPL::OperatorOutputPort::getExportType ( ) const

pure virtual

Get the export type for the port

Returns: export type for the port

virtual void SPL::OperatorOutputPort::getStreamProperties ( StreamPropertyCollection & spc ) const

pure virtual

Get all the properties of this output port's stream

Parameters

spc the set of properties retrieved ('out' parameter)

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties

virtual void SPL::OperatorOutputPort::getStreamProperties ( StreamPropertyCollection & spc,

std::vector< std::string > const & names

) const

pure virtual

Get the specified properties of this output port's stream

Parameters

spc the set of properties retrieved ('out' parameter)

names the names of the properties to be retrieved

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or one of the names is not present

virtual void SPL::OperatorOutputPort::setStreamProperties ( StreamPropertyCollection const & spc ) const

pure virtual

Set the specified properties of this output port's stream

Parameters

spc the set of properties to be set

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or one of the properties does not exist

virtual void SPL::OperatorOutputPort::addStreamProperties ( StreamPropertyCollection const & spc ) const

pure virtual

Add the specified properties to this output port's stream

Parameters

spc the set of properties to be added

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or one of the properties already exists

virtual void SPL::OperatorOutputPort::removeStreamProperties ( std::vector< std::string > const & spc ) const

pure virtual

Remove the specified properties from this output port's stream

Parameters

spc the set of properties to be removed

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or one of the properties does not exist

virtual bool SPL::OperatorOutputPort::hasStreamProperty ( std::string const & sp ) const

pure virtual

Check if a property of this output port's stream exists

Parameters

sp the property to be checked for existence

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties

virtual void SPL::OperatorOutputPort::getStreamProperty ( StreamProperty & sp,

std::string const & name

) const

pure virtual

Get a property of this output port's stream

Parameters

sp the property to be retreived ('out' parameter)

name the name of the stream property to be retrieved

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or the property does not exist

virtual void SPL::OperatorOutputPort::setStreamProperty ( StreamProperty const & sp ) const

pure virtual

Set a property of this output port's stream

Parameters

sp the property to be set

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or the property does not exist

virtual void SPL::OperatorOutputPort::addStreamProperty ( StreamProperty const & sp ) const

pure virtual

Add a property to this output port's stream

Parameters

sp the property to be added

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or the property already exists

virtual void SPL::OperatorOutputPort::removeStreamProperty ( std::string const & sp ) const

pure virtual

Remove a property of an operator's output port's stream

Parameters

sp the property to be removed

Exceptions

SPLRuntimeStreamPropertyException if the stream is not exported by properties or the property does not exist

virtual bool SPL::OperatorOutputPort::isConnectedToAPEOutputPort ( ) const

pure virtual

Check if this output port is connected to a PE output port

Returns: true if connected to a PE output port, false otherwise

virtual uint32_t SPL::OperatorOutputPort::getPEOutputPortIndex ( ) const

pure virtual

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

The documentation for this class was generated from the following file:

SPL/Runtime/Operator/Port/OperatorOutputPort.h