Essentia  2.1-beta5-dev
PoolStorage< TokenType, StorageType > Class Template Reference

#include <poolstorage.h>

Inheritance diagram for PoolStorage< TokenType, StorageType >:
PoolStorageBase Algorithm Configurable

Public Member Functions

 PoolStorage (Pool *pool, const std::string &descriptorName, bool setSingle=false)
 
 ~PoolStorage ()
 
void declareParameters ()
 
AlgorithmStatus process ()
 
template<typename T >
void addToPool (const std::vector< T > &value)
 
void addToPool (const std::vector< Real > &value)
 
template<typename T >
void addToPool (const T &value)
 
template<typename T >
void addToPool (const TNT::Array2D< T > &value)
 
void addToPool (const StereoSample &value)
 
- Public Member Functions inherited from PoolStorageBase
 PoolStorageBase (Pool *pool, const std::string &descriptorName, bool setSingle=false)
 
 ~PoolStorageBase ()
 
const std::string & descriptorName () const
 
Poolpool () const
 
- Public Member Functions inherited from Algorithm
 Algorithm ()
 
virtual ~Algorithm ()
 
SinkBaseinput (const std::string &name)
 
SourceBaseoutput (const std::string &name)
 
SinkBaseinput (int idx)
 
SourceBaseoutput (int idx)
 
const InputMapinputs () const
 
const OutputMapoutputs () const
 
std::vector< std::string > inputNames () const
 
std::vector< std::string > outputNames () const
 
virtual void shouldStop (bool stop)
 
virtual bool shouldStop () const
 
void disconnectAll ()
 
AlgorithmStatus acquireData ()
 
void releaseData ()
 
virtual void reset ()
 
- Public Member Functions inherited from Configurable
virtual ~Configurable ()
 
const std::string & name () const
 
void setName (const std::string &name)
 
virtual void setParameters (const ParameterMap &params)
 
virtual void configure (const ParameterMap &params)
 
virtual void configure ()
 
const ParameterMapdefaultParameters () const
 
const Parameterparameter (const std::string &key) const
 

Protected Attributes

Sink< TokenType > _descriptor
 
- Protected Attributes inherited from PoolStorageBase
Pool_pool
 
std::string _descriptorName
 
bool _setSingle
 
- Protected Attributes inherited from Algorithm
bool _shouldStop
 
OutputMap _outputs
 
InputMap _inputs
 
int nProcess
 
- Protected Attributes inherited from Configurable
std::string _name
 
ParameterMap _params
 
ParameterMap _defaultParams
 

Additional Inherited Members

- Public Types inherited from Algorithm
typedef OrderedMap< SinkBaseInputMap
 
typedef OrderedMap< SourceBaseOutputMap
 
- Public Attributes inherited from Algorithm
DescriptionMap inputDescription
 
DescriptionMap outputDescription
 
- Public Attributes inherited from Configurable
DescriptionMap parameterDescription
 
DescriptionMap parameterRange
 
- Static Public Attributes inherited from Algorithm
static const std::string processingMode
 
- Protected Member Functions inherited from Algorithm
void declareInput (SinkBase &sink, const std::string &name, const std::string &desc)
 
void declareInput (SinkBase &sink, int n, const std::string &name, const std::string &desc)
 
void declareInput (SinkBase &sink, int acquireSize, int releaseSize, const std::string &name, const std::string &desc)
 
void declareOutput (SourceBase &source, const std::string &name, const std::string &desc)
 
void declareOutput (SourceBase &source, int n, const std::string &name, const std::string &desc)
 
void declareOutput (SourceBase &source, int acquireSize, int releaseSize, const std::string &name, const std::string &desc)
 
- Protected Member Functions inherited from Configurable
void declareParameter (const std::string &name, const std::string &desc, const std::string &range, const Parameter &defaultValue)
 

Constructor & Destructor Documentation

◆ PoolStorage()

PoolStorage ( Pool pool,
const std::string &  descriptorName,
bool  setSingle = false 
)
inline

◆ ~PoolStorage()

~PoolStorage ( )
inline

Member Function Documentation

◆ addToPool() [1/5]

void addToPool ( const std::vector< T > &  value)
inline

◆ addToPool() [2/5]

void addToPool ( const std::vector< Real > &  value)
inline

◆ addToPool() [3/5]

void addToPool ( const T &  value)
inline

◆ addToPool() [4/5]

void addToPool ( const TNT::Array2D< T > &  value)
inline

◆ addToPool() [5/5]

◆ declareParameters()

void declareParameters ( )
inlinevirtual

Declare the parameters that this Configurable can accept. You have to implement this method in derived classes, even though you don't need any parameters. In that case, just define it as empty.

In this method you should only be calling the declareParameter method, once for each parameter, with optional default values.

Implements Configurable.

◆ process()

Member Data Documentation

◆ _descriptor

Sink<TokenType> _descriptor
protected

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