Essentia  2.1-beta5-dev
VectorInput< TokenType, acquireSize > Class Template Reference

#include <vectorinput.h>

Inheritance diagram for VectorInput< TokenType, acquireSize >:
Algorithm Configurable

Public Member Functions

 VectorInput (const std::vector< TokenType > *input=0, bool own=false)
 
 VectorInput (std::vector< TokenType > *input, bool own=false)
 
template<typename Array >
 VectorInput (const Array &inputArray, bool own=true)
 
 VectorInput (const TNT::Array2D< Real > &input)
 
 ~VectorInput ()
 
void clear ()
 
void setVector (const std::vector< TokenType > *input, bool own=false)
 
void setAcquireSize (const int size)
 
void reset ()
 
bool shouldStop () const
 
AlgorithmStatus process ()
 
void declareParameters ()
 
- 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)
 
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 ParameterMapdefaultParameters () const
 
const Parameterparameter (const std::string &key) const
 

Protected Attributes

Source< TokenType > _output
 
const std::vector< TokenType > * _inputVector
 
bool _ownVector
 
int _idx
 
int _acquireSize
 
- 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

◆ VectorInput() [1/4]

◆ VectorInput() [2/4]

◆ VectorInput() [3/4]

◆ VectorInput() [4/4]

◆ ~VectorInput()

Member Function Documentation

◆ clear()

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

◆ 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.

References Algorithm::reset(), StreamConnector::setAcquireSize(), and StreamConnector::setReleaseSize().

Referenced by VectorInput< TokenType, acquireSize >::VectorInput().

◆ setAcquireSize()

◆ setVector()

void setVector ( const std::vector< TokenType > *  input,
bool  own = false 
)
inline

TODO: Should we make a copy of the vector here or only keep the ref?

References VectorInput< TokenType, acquireSize >::clear(), and Algorithm::input().

◆ shouldStop()

bool shouldStop ( ) const
inlinevirtual

Returns whether the algorithm should stop, ie: it has received an end-of-stream signal.

Reimplemented from Algorithm.

Referenced by VectorInput< TokenType, acquireSize >::process().

Member Data Documentation

◆ _acquireSize

int _acquireSize
protected

◆ _idx

int _idx
protected

◆ _inputVector

const std::vector<TokenType>* _inputVector
protected

◆ _output

Source<TokenType> _output
protected

◆ _ownVector

bool _ownVector
protected

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