blockfactory  0.8
A framework for wrapping algorithms for dataflow programming
Classes | Public Types | Public Member Functions | Static Public Attributes | List of all members
blockfactory::core::Port Class Referenceabstract

Class that stores port properties. More...

#include <Port.h>

Detailed Description

Class that stores port properties.

Ports are virtual entities associated to blocks, and they provide the interface between a block and a signal, carrying the required information.

Note
Currently only 1D and 2D ports are supported.
This class is just a placeholder of information. It might become a concrete class in the future.
See also
core::Signal, core::Block

Classes

struct  Info
 A container of port information. More...
 
struct  Size
 Contained of size-related properties of ports. More...
 

Public Types

enum  DataType {
  DataType::DOUBLE, DataType::SINGLE, DataType::INT8, DataType::UINT8,
  DataType::INT16, DataType::UINT16, DataType::INT32, DataType::UINT32,
  DataType::BOOLEAN
}
 Defines allowed port data types. More...
 
using Index = size_t
 The 0-based index of a port. More...
 
using Dimensions = std::vector< int >
 

Public Member Functions

virtual ~Port ()=0
 

Static Public Attributes

static const int DynamicSize = -1
 Identifier of a port with dynamic size. More...
 

Member Typedef Documentation

using blockfactory::core::Port::Dimensions = std::vector<int>

Specifies the dimensions of a port. Only 1D and 2D ports (and hence signals) are currently supported

using blockfactory::core::Port::Index = size_t

The 0-based index of a port.

Member Enumeration Documentation

enum blockfactory::core::Port::DataType
strong

Defines allowed port data types.

The port data type specifies which kind of core::Signal object can be plugged into a port.

Note
Currently only DOUBLE is fully implemented.
See also
core::Signal::Signal, core::BlockInformation::setInputPortType, core::BlockInformation::setOutputPortType
Enumerator
DOUBLE 
SINGLE 
INT8 
UINT8 
INT16 
UINT16 
INT32 
UINT32 
BOOLEAN 

Constructor & Destructor Documentation

virtual blockfactory::core::Port::~Port ( )
pure virtual

Member Data Documentation

const int blockfactory::core::Port::DynamicSize = -1
static

Identifier of a port with dynamic size.

This usually applied when a port is initialized without knowing its dimesions, and it might happen before the signal-size propagation by the engine.

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