CLAM-Development
1.4.0
|
This Processing class only calls the Compute operation of Descriptor passed to the Do. More...
#include <DescriptorComputation.hxx>
Public Member Functions | |
DescriptorComputation () | |
DescriptorComputation (const DescriptorComputationConfig &c) | |
~DescriptorComputation () | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
bool | Do (void) |
Supervised mode execution method (using ports) | |
bool | Do (Descriptor &input) |
bool | Do (DescriptorAbs &input) |
![]() | |
bool | Configure (const ProcessingConfig &config) |
Configuration change method. | |
void | Start (void) |
Method to turn the object into running state. | |
void | Stop (void) |
Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods. | |
Processing () | |
virtual | ~Processing () |
virtual bool | CanProcessInplace () |
Override this method if your processing cannot process inplace. | |
bool | CanConsumeAndProduce () |
Check that Supervised Do() can be safely called. | |
void | ConsumeAndProduce () |
Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts. | |
std::string | GetExecStateString () const |
bool | IsConfigured () const |
bool | IsRunning () const |
void | RegisterOutPort (OutPortBase *out) |
void | RegisterInPort (InPortBase *in) |
void | RegisterOutControl (OutControlBase *out) |
void | RegisterInControl (InControlBase *in) |
void | SetParent (Processing *p) |
void | SetNetworkBackLink (Network *network) |
virtual bool | ModifiesPortsAndControlsAtConfiguration () |
This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e. | |
bool | HasInPort (const std::string &name) |
bool | HasOutPort (const std::string &name) |
bool | HasInControl (const std::string &name) |
bool | HasOutControl (const std::string &name) |
InPortBase & | GetInPort (const std::string &name) |
OutPortBase & | GetOutPort (const std::string &name) |
InControlBase & | GetInControl (const std::string &name) |
OutControlBase & | GetOutControl (const std::string &name) |
InPortBase & | GetInPort (unsigned index) |
OutPortBase & | GetOutPort (unsigned index) |
InControlBase & | GetInControl (unsigned index) |
OutControlBase & | GetOutControl (unsigned index) |
unsigned | GetNInPorts () const |
unsigned | GetNOutPorts () const |
unsigned | GetNInControls () const |
unsigned | GetNOutControls () const |
const std::string & | GetConfigErrorMessage () const |
Returns a string describing configuration errors if any. | |
virtual bool | IsSyncSource () const |
Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e. | |
virtual bool | SupportsVariableAudioSize () const |
This method reports whether the processing supports dynamic buffer-size host. |
Protected Member Functions | |
const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
bool | ConcreteConfigure (const ProcessingConfig &c) |
Config change method. | |
![]() | |
virtual bool | ConcreteStart () |
Processing objects have to redefine this method when starting them implies some internal changes. | |
virtual bool | ConcreteStop () |
Processing objects have to redefine this method when stoping them implies some internal changes. | |
unsigned | BackendBufferSize () |
Given by the NetworkPlayer (backend) if exists. | |
unsigned | BackendSampleRate () |
Given by the NetworkPlayer (backend) if exists. | |
InControlRegistry & | GetInControls () |
Accessor to published Controls manager. | |
OutControlRegistry & | GetOutControls () |
Accessor to published Controls manager. | |
InPortRegistry & | GetInPorts () |
Accessor to published Ports manager. | |
OutPortRegistry & | GetOutPorts () |
Accessor to published Portss manager. | |
bool | AddConfigErrorMessage (const std::string &msg) |
Use this method to append a configuration errors to the processing when implementing ConcreteConfigure. | |
bool | AbleToExecute (void) const |
In debug-mode checks that the processing is configured and started. | |
template<typename ConcreteConfig > | |
void | CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const |
Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter. | |
void | SetExecState (ExecState state) |
Protected Attributes | |
DescriptorComputationConfig | mConfig |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
This Processing class only calls the Compute operation of Descriptor passed to the Do.
Definition at line 34 of file DescriptorComputation.hxx.
CLAM::DescriptorComputation::DescriptorComputation | ( | ) |
Definition at line 27 of file DescriptorComputation.cxx.
References CLAM::Processing::Configure().
CLAM::DescriptorComputation::DescriptorComputation | ( | const DescriptorComputationConfig & | c | ) |
Definition at line 32 of file DescriptorComputation.cxx.
References CLAM::Processing::Configure().
CLAM::DescriptorComputation::~DescriptorComputation | ( | ) |
Definition at line 37 of file DescriptorComputation.cxx.
|
protectedvirtual |
Config change method.
Reimplemented from CLAM::Processing.
Definition at line 41 of file DescriptorComputation.cxx.
References CLAM::Processing::CopyAsConcreteConfig(), and mConfig.
|
virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Definition at line 52 of file DescriptorComputation.cxx.
bool CLAM::DescriptorComputation::Do | ( | Descriptor & | input | ) |
Definition at line 58 of file DescriptorComputation.cxx.
References CLAM::DescriptorTmpl< abs >::Compute().
bool CLAM::DescriptorComputation::Do | ( | DescriptorAbs & | input | ) |
|
protectedvirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 47 of file DescriptorComputation.cxx.
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Definition at line 51 of file DescriptorComputation.hxx.
References mConfig.
|
protected |
Definition at line 58 of file DescriptorComputation.hxx.
Referenced by ConcreteConfigure(), and GetConfig().