blockfactory  0.8
A framework for wrapping algorithms for dataflow programming
Public Member Functions | Private Types | Private Attributes | List of all members
blockfactory::core::Parameter< T > Class Template Reference

Class for storing a generic parameter. More...

#include <Parameter.h>

Detailed Description

template<typename T>
class blockfactory::core::Parameter< T >

Class for storing a generic parameter.

A generic parameters can be either a scalar or a vector. Supported types are defined by the core::ParameterType enum. Use core::ParameterMetadata to set these information.

Template Parameters
Thetype of the container type. For vector parameters, T is the type of an element of the container.
See also
core::Parameters, core::ParameterMetadata

Public Member Functions

 Parameter ()=delete
 
 ~Parameter ()=default
 
 Parameter (const T &value, const blockfactory::core::ParameterMetadata &md)
 
 Parameter (const ParamVector &valueVec, const blockfactory::core::ParameterMetadata &md)
 
bool isScalar () const
 
T getScalarParameter () const
 
ParamVector getVectorParameter () const
 
blockfactory::core::ParameterMetadata getMetadata () const
 

Private Types

using ParamVector = std::vector< T >
 

Private Attributes

bool m_isScalar
 
T m_valueScalar
 
ParamVector m_valueVector
 
blockfactory::core::ParameterMetadata m_metadata
 

Member Typedef Documentation

template<typename T>
using blockfactory::core::Parameter< T >::ParamVector = std::vector<T>
private

Constructor & Destructor Documentation

template<typename T>
blockfactory::core::Parameter< T >::Parameter ( )
delete
template<typename T>
blockfactory::core::Parameter< T >::~Parameter ( )
default
template<typename T>
blockfactory::core::Parameter< T >::Parameter ( const T &  value,
const blockfactory::core::ParameterMetadata &  md 
)
inline
template<typename T>
blockfactory::core::Parameter< T >::Parameter ( const ParamVector &  valueVec,
const blockfactory::core::ParameterMetadata &  md 
)
inline

Member Function Documentation

template<typename T>
blockfactory::core::ParameterMetadata blockfactory::core::Parameter< T >::getMetadata ( ) const
inline
template<typename T>
T blockfactory::core::Parameter< T >::getScalarParameter ( ) const
inline
template<typename T>
ParamVector blockfactory::core::Parameter< T >::getVectorParameter ( ) const
inline
template<typename T>
bool blockfactory::core::Parameter< T >::isScalar ( ) const
inline

Member Data Documentation

template<typename T>
bool blockfactory::core::Parameter< T >::m_isScalar
private
template<typename T>
blockfactory::core::ParameterMetadata blockfactory::core::Parameter< T >::m_metadata
private
template<typename T>
T blockfactory::core::Parameter< T >::m_valueScalar
private
template<typename T>
ParamVector blockfactory::core::Parameter< T >::m_valueVector
private
The documentation for this class was generated from the following file: