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

#include <SDIFOut.hxx>

List of all members.

Public Member Functions

 SDIFOut (const SDIFOutConfig &c)
 SDIFOut ()
virtual ~SDIFOut ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool GetEnableResidual ()
bool GetEnablePeakArray ()
bool GetEnableFundFreq ()
bool Do (void)
 Supervised mode execution method (using ports)
bool Do (const Frame &frame)
const ProcessingConfigGetConfig () const
 Configuration getter.
- 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.

Public Attributes

SDIF::FilempFile

Protected Member Functions

bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
- Protected Member Functions inherited from CLAM::Processing
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

InPort< FundamentalmInputFundamental
InPort< SpectralPeakArraymInputSinSpectralPeaks
InPort< SpectrummInputResSpectrum
- 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

Definition at line 58 of file SDIFOut.hxx.


Constructor & Destructor Documentation

SDIFOut::SDIFOut ( const SDIFOutConfig c)

Definition at line 65 of file SDIFOut.cxx.

References CLAM::Processing::Configure(), mpFile, and NULL.

SDIFOut::SDIFOut ( )

Definition at line 54 of file SDIFOut.cxx.

References CLAM::Processing::Configure(), mpFile, and NULL.

SDIFOut::~SDIFOut ( )
virtual

Definition at line 77 of file SDIFOut.cxx.

References SDIF::File::Close(), and mpFile.


Member Function Documentation

bool SDIFOut::ConcreteStart ( void  )
protectedvirtual

Processing objects have to redefine this method when starting them implies some internal changes.

ie: adquiring resources.

Returns:
Whether start changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 89 of file SDIFOut.cxx.

References CLAM::Processing::AddConfigErrorMessage(), SDIF::File::eOutput, mpFile, SDIF::File::Open(), and CLAM::Err::what().

bool SDIFOut::ConcreteStop ( )
protectedvirtual

Processing objects have to redefine this method when stoping them implies some internal changes.

ie: releasing resources.

Returns:
Whether stop changes have been successful

Reimplemented from CLAM::Processing.

Definition at line 111 of file SDIFOut.cxx.

References SDIF::File::Close(), and mpFile.

bool SDIFOut::Do ( void  )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 131 of file SDIFOut.cxx.

References CLAM::InPort< Token >::GetData(), mInputResSpectrum, and mInputSinSpectralPeaks.

bool SDIFOut::Do ( const Frame frame)
const char* CLAM::SDIFOut::GetClassName ( ) const
inlinevirtual

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

Implements CLAM::Processing.

Definition at line 66 of file SDIFOut.hxx.

const ProcessingConfig & SDIFOut::GetConfig ( ) const
virtual

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 126 of file SDIFOut.cxx.

bool CLAM::SDIFOut::GetEnableFundFreq ( )
inline

Definition at line 70 of file SDIFOut.hxx.

bool CLAM::SDIFOut::GetEnablePeakArray ( )
inline

Definition at line 69 of file SDIFOut.hxx.

bool CLAM::SDIFOut::GetEnableResidual ( )
inline

Definition at line 68 of file SDIFOut.hxx.


Member Data Documentation

InPort<Fundamental> CLAM::SDIFOut::mInputFundamental
protected

Definition at line 86 of file SDIFOut.hxx.

InPort<Spectrum> CLAM::SDIFOut::mInputResSpectrum
protected

Definition at line 88 of file SDIFOut.hxx.

Referenced by Do().

InPort<SpectralPeakArray> CLAM::SDIFOut::mInputSinSpectralPeaks
protected

Definition at line 87 of file SDIFOut.hxx.

Referenced by Do().

SDIF::File* CLAM::SDIFOut::mpFile

Definition at line 78 of file SDIFOut.hxx.

Referenced by ConcreteStart(), ConcreteStop(), Do(), SDIFOut(), and ~SDIFOut().


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