CLAM-Development  1.4.0
Public Member Functions | Protected Member Functions | Protected Attributes
CLAM::DescriptorComputation Class Reference

This Processing class only calls the Compute operation of Descriptor passed to the Do. More...

#include <DescriptorComputation.hxx>

List of all members.

Public Member Functions

 DescriptorComputation ()
 DescriptorComputation (const DescriptorComputationConfig &c)
 ~DescriptorComputation ()
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports)
bool Do (Descriptor &input)
bool Do (DescriptorAbs &input)
- Public Member Functions inherited from CLAM::Processing
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)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (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.
- Protected Member Functions inherited from CLAM::Processing
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.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 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
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Additional Inherited Members

- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config

Detailed Description

This Processing class only calls the Compute operation of Descriptor passed to the Do.

Definition at line 34 of file DescriptorComputation.hxx.


Constructor & Destructor Documentation

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.


Member Function Documentation

bool CLAM::DescriptorComputation::ConcreteConfigure ( const ProcessingConfig c)
protectedvirtual

Config change method.

Reimplemented from CLAM::Processing.

Definition at line 41 of file DescriptorComputation.cxx.

References CLAM::Processing::CopyAsConcreteConfig(), and mConfig.

bool CLAM::DescriptorComputation::Do ( void  )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

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)
const char * CLAM::DescriptorComputation::GetClassName ( ) const
protectedvirtual

Override it in every subclass and retur the name of that class.

Implements CLAM::Processing.

Definition at line 47 of file DescriptorComputation.cxx.

const ProcessingConfig& CLAM::DescriptorComputation::GetConfig ( ) const
inlinevirtual

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:
Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Definition at line 51 of file DescriptorComputation.hxx.

References mConfig.


Member Data Documentation

DescriptorComputationConfig CLAM::DescriptorComputation::mConfig
protected

Definition at line 58 of file DescriptorComputation.hxx.

Referenced by ConcreteConfigure(), and GetConfig().


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