CLAM::SMSSinusoidalGain Class Reference

#include <SMSSinusoidalGain.hxx>

List of all members.

Public Member Functions

 SMSSinusoidalGain ()
 ~SMSSinusoidalGain ()
bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration method interface.
bool Do (const Frame &in, Frame &out)
bool Do (const SpectralPeakArray &in, SpectralPeakArray &out)
bool Do ()
 Supervised mode execution method (using ports).

Detailed Description

Definition at line 38 of file SMSSinusoidalGain.hxx.

Constructor & Destructor Documentation

CLAM::SMSSinusoidalGain::SMSSinusoidalGain (  )  [inline]

Definition at line 48 of file SMSSinusoidalGain.hxx.

References CLAM::Processing::Configure().

CLAM::SMSSinusoidalGain::~SMSSinusoidalGain (  )  [inline]

Definition at line 57 of file SMSSinusoidalGain.hxx.

Member Function Documentation

bool CLAM::SMSSinusoidalGain::ConcreteConfigure ( const ProcessingConfig &   )  [inline, virtual]

Configuration method interface.

The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.

Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.

Parameters:
Reference to the configuration object.
Returns:
false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:
This method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 59 of file SMSSinusoidalGain.hxx.

References CLAM::InControl< ControlDataType >::DoControl(), CLAM::InControlBase::SetBounds(), and CLAM::InControlBase::SetDefaultValue().

bool CLAM::SMSSinusoidalGain::Do (  )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 74 of file SMSSinusoidalGain.hxx.

References CLAM::InPort< Token >::Consume(), CLAM::OutPort< Token >::GetData(), CLAM::InPort< Token >::GetData(), and CLAM::OutPort< Token >::Produce().

Referenced by Do().

bool CLAM::SMSSinusoidalGain::Do ( const SpectralPeakArray &  in,
SpectralPeakArray &  out 
)

Definition at line 41 of file SMSSinusoidalGain.cxx.

References CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::SpectralPeakArray::GetnMaxPeaks(), CLAM::SpectralPeakArray::GetnPeaks(), CLAM::SpectralPeakArray::GetSpectralPeak(), CLAM::SpectralPeakArray::SetnMaxPeaks(), CLAM::SpectralPeakArray::SetnPeaks(), and CLAM::SpectralPeakArray::SetSpectralPeak().

bool CLAM::SMSSinusoidalGain::Do ( const Frame &  in,
Frame &  out 
) [inline, virtual]

Implements CLAM::FrameTransformation.

Definition at line 67 of file SMSSinusoidalGain.hxx.

References Do().

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3