CLAM::SMSResidualGain Class Reference

#include <SMSResidualGain.hxx>

List of all members.

Public Member Functions

 SMSResidualGain ()
 ~SMSResidualGain ()
bool ConcreteConfigure (const ProcessingConfig &c)
 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 SMSResidualGain.hxx.

Constructor & Destructor Documentation

CLAM::SMSResidualGain::SMSResidualGain (  )  [inline]

Definition at line 47 of file SMSResidualGain.hxx.

References CLAM::Processing::Configure().

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

Definition at line 56 of file SMSResidualGain.hxx.

Member Function Documentation

bool CLAM::SMSResidualGain::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.

Reference to the configuration object.
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.

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 58 of file SMSResidualGain.hxx.

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

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

Supervised mode execution method (using ports).

A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 73 of file SMSResidualGain.hxx.

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

Referenced by Do().

bool CLAM::SMSResidualGain::Do ( const Spectrum in,
Spectrum out 

Definition at line 37 of file SMSResidualGain.cxx.

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

Implements CLAM::FrameTransformation.

Definition at line 66 of file SMSResidualGain.hxx.

References Do().

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