Essentia  2.1-beta5-dev
AlgorithmComposite Class Referenceabstract

#include <streamingalgorithmcomposite.h>

Inheritance diagram for AlgorithmComposite:
Algorithm Configurable

Public Member Functions

void declareInput (SinkBase &sink, const std::string &name, const std::string &desc)
 
void declareOutput (SourceBase &source, 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, 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)
 
AlgorithmStatus process ()
 
virtual void declareProcessOrder ()=0
 
std::vector< ProcessStepprocessOrder ()
 
void reset ()
 
void declareProcessStep (const ProcessStep &step)
 
- 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 declareParameters ()=0
 
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

std::vector< ProcessStep_processOrder
 
- 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)
 

Member Function Documentation

◆ declareInput() [1/3]

void declareInput ( SinkBase sink,
const std::string &  name,
const std::string &  desc 
)

◆ declareInput() [2/3]

void declareInput ( SinkBase sink,
int  n,
const std::string &  name,
const std::string &  desc 
)
inline

◆ declareInput() [3/3]

void declareInput ( SinkBase sink,
int  acquireSize,
int  releaseSize,
const std::string &  name,
const std::string &  desc 
)
inline

◆ declareOutput() [1/3]

void declareOutput ( SourceBase source,
const std::string &  name,
const std::string &  desc 
)

◆ declareOutput() [2/3]

void declareOutput ( SourceBase source,
int  n,
const std::string &  name,
const std::string &  desc 
)
inline

◆ declareOutput() [3/3]

void declareOutput ( SourceBase source,
int  acquireSize,
int  releaseSize,
const std::string &  name,
const std::string &  desc 
)
inline

◆ declareProcessOrder()

virtual void declareProcessOrder ( )
pure virtual

◆ declareProcessStep()

void declareProcessStep ( const ProcessStep step)

◆ process()

AlgorithmStatus process ( )
inlinevirtual

By default, does nothing, just waits for its inner algorithms to be scheduled for execution by the task scheduler.

Implements Algorithm.

References essentia::streaming::PASS.

◆ processOrder()

std::vector<ProcessStep> processOrder ( )

◆ reset()

void reset ( )
virtual

Specialized implementation of the reset() method that will call reset() on all the algorithms traversed by the defined process order.

Reimplemented from Algorithm.

Member Data Documentation

◆ _processOrder

std::vector<ProcessStep> _processOrder
protected

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