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 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 Attributes

InPort< FundamentalmInputFundamental
InPort< SpectralPeakArraymInputSinSpectralPeaks
InPort< SpectrummInputResSpectrum

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   )  [protected, virtual]

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 (  )  [protected, virtual]

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 ( const Frame frame  ) 
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.

const char* CLAM::SDIFOut::GetClassName (  )  const [inline, virtual]

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

Definition at line 86 of file SDIFOut.hxx.

Definition at line 88 of file SDIFOut.hxx.

Referenced by Do().

Definition at line 87 of file SDIFOut.hxx.

Referenced by Do().

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:
Generated by  doxygen 1.6.3