CLAM::SMSTranspose Class Reference

#include <SMSTranspose.hxx>

Inheritance diagram for CLAM::SMSTranspose:

List of all members.

Public Member Functions

const char * GetClassName () const

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

SMSTranspose ()

~SMSTranspose ()

bool ConcreteConfigure (const ProcessingConfig &config)

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 37 of file SMSTranspose.hxx.

Constructor & Destructor Documentation

CLAM::SMSTranspose::SMSTranspose ( ) [inline]

Definition at line 49 of file SMSTranspose.hxx.

References CLAM::Processing::Configure().

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

Definition at line 58 of file SMSTranspose.hxx.

Member Function Documentation

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

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

Implements CLAM::Processing.

Definition at line 44 of file SMSTranspose.hxx.

bool CLAM::SMSTranspose::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 60 of file SMSTranspose.hxx.

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

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

Implements CLAM::FrameTransformation.

Definition at line 67 of file SMSTranspose.hxx.

References Do().

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

Definition at line 39 of file SMSTranspose.cxx.

References CLAM::InControl< ControlDataType >::GetLastValue(), CLAM::SpectralPeakArray::GetnPeaks(), and CLAM::FrameTransformation::mConfig.

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

Supervised mode execution method (using ports).

Returns:: A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 75 of file SMSTranspose.hxx.

Referenced by Do().

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


Public Member Functions
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
	SMSTranspose ()
	~SMSTranspose ()
bool	ConcreteConfigure (const ProcessingConfig &config)
	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).