Essentia  2.1-beta5-dev
RingBufferOutput Class Reference

#include <ringbufferoutput.h>

Inheritance diagram for RingBufferOutput:
Algorithm Configurable

Public Member Functions

 RingBufferOutput ()
 
 ~RingBufferOutput ()
 
int get (Real *outputData, int max)
 
AlgorithmStatus process ()
 
void declareParameters ()
 
void configure ()
 
void reset ()
 
- 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 ()
 
- 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)
 
const ParameterMapdefaultParameters () const
 
const Parameterparameter (const std::string &key) const
 

Static Public Attributes

static const char * name
 
static const char * category
 
static const char * description
 
- Static Public Attributes inherited from Algorithm
static const std::string processingMode
 

Protected Attributes

Sink< Real_input
 
class RingBufferImpl_impl
 
- 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
 
- 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

◆ RingBufferOutput()

◆ ~RingBufferOutput()

Member Function Documentation

◆ configure()

void configure ( )
virtual

This function will be automatically called after some parameters have been set. This is the place where you should write your specific code which needs to be called when configuring this object.

You can access the newly set parameters using the parameter() method.

Reimplemented from Configurable.

Referenced by RingBufferOutput::declareParameters().

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

References RingBufferOutput::configure(), Configurable::declareParameter(), and RingBufferOutput::reset().

◆ get()

int get ( Real outputData,
int  max 
)

◆ process()

AlgorithmStatus process ( )
virtual

Implements Algorithm.

◆ reset()

void reset ( )
virtual

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.

Referenced by RingBufferOutput::declareParameters().

Member Data Documentation

◆ _impl

class RingBufferImpl* _impl
protected

◆ _input

Sink<Real> _input
protected

◆ category

const char* category
static

◆ description

const char* description
static

◆ name

const char* name
static

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