VectorOutput< TokenType, StorageType > Class Template Reference

#include <vectoroutput.h>

Inheritance diagram for VectorOutput< TokenType, StorageType >:

Public Member Functions
	VectorOutput (std::vector< TokenType > *v=0)
	~VectorOutput ()
void	declareParameters ()
void	setVector (std::vector< TokenType > *v)
AlgorithmStatus	process ()
void	reset ()
Public Member Functions inherited from Algorithm
	Algorithm ()
virtual	~Algorithm ()
SinkBase &	input (const std::string &name)
SourceBase &	output (const std::string &name)
SinkBase &	input (int idx)
SourceBase &	output (int idx)
const InputMap &	inputs () const
const OutputMap &	outputs () 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 ()
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 ParameterMap &	defaultParameters () const
const Parameter &	parameter (const std::string &key) const

Protected Attributes
Sink< TokenType >	_data
std::vector< TokenType > *	_v
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< SinkBase >	InputMap
typedef OrderedMap< SourceBase >	OutputMap
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)

Detailed Description

template<typename TokenType, typename StorageType = TokenType>
class essentia::streaming::VectorOutput< TokenType, StorageType >

VectorOutput class that pushes all data coming at its input into a std::vector. Note that you don't need to configure the VectorOutput to an optimized acquireSize, as it will figure out by itself what's the maximum number of tokens it can acquire at once, and this in a smart dynamic way.

Constructor & Destructor Documentation

VectorOutput()

VectorOutput ( std::vector< TokenType > *  v = 0 )

inline

References VectorOutput< TokenType, StorageType >::_data, Algorithm::declareInput(), and Configurable::setName().

~VectorOutput()

~VectorOutput ( )

inline

Member Function Documentation

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()

AlgorithmStatus process ( )

inlinevirtual

Implements Algorithm.

References VectorOutput< TokenType, StorageType >::_data, VectorOutput< TokenType, StorageType >::_v, EXEC_DEBUG, essentia::fastcopy(), essentia::streaming::NO_INPUT, and essentia::streaming::OK.

reset()

void reset ( )

inlinevirtual

This function will be called when doing batch computations between each file that is processed. That is, if your algorithm is some sort of state machine, it allows you to reset it to its original state to process another file without having to delete and reinstantiate it. This function should not be called directly. Use resetNetwork instead to reset a network of connected Algorithms.

Reimplemented from Algorithm.

setVector()

void setVector ( std::vector< TokenType > *  v )

inline

References VectorOutput< TokenType, StorageType >::_v.

Member Data Documentation

_data

Sink<TokenType> _data

protected

Referenced by VectorOutput< TokenType, StorageType >::process(), and VectorOutput< TokenType, StorageType >::VectorOutput().

_v

std::vector<TokenType>* _v

protected

Referenced by VectorOutput< TokenType, StorageType >::process(), and VectorOutput< TokenType, StorageType >::setVector().

---

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

• src/essentia/streaming/algorithms/vectoroutput.h