CLAM::OscillatingSpectralNotch Class Reference

#include <OscillatingSpectralNotch.hxx>

List of all members.

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
 OscillatingSpectralNotch ()
 ~OscillatingSpectralNotch ()
bool ConcreteConfigure (const ProcessingConfig &config)
 Configuration method interface.
bool Do (const Frame &in, Frame &out)
bool Do (const Spectrum &in, Spectrum &out)
bool Do ()
 Supervised mode execution method (using ports).

Detailed Description

Definition at line 37 of file OscillatingSpectralNotch.hxx.

Constructor & Destructor Documentation

CLAM::OscillatingSpectralNotch::OscillatingSpectralNotch (  )  [inline]

Definition at line 54 of file OscillatingSpectralNotch.hxx.

References CLAM::Processing::Configure().

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

Definition at line 67 of file OscillatingSpectralNotch.hxx.

Member Function Documentation

bool CLAM::OscillatingSpectralNotch::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 68 of file OscillatingSpectralNotch.hxx.

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

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

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 100 of file OscillatingSpectralNotch.hxx.

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

Referenced by Do().

bool CLAM::OscillatingSpectralNotch::Do ( const Spectrum &  in,
Spectrum &  out 
) [virtual]

Implements CLAM::FrameTransformationTmpl< Spectrum >.

Definition at line 35 of file OscillatingSpectralNotch.cxx.

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

Implements CLAM::FrameTransformation.

Definition at line 92 of file OscillatingSpectralNotch.hxx.

References Do().

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

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

Implements CLAM::Processing.

Definition at line 49 of file OscillatingSpectralNotch.hxx.

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