CLAM::SDIFIn Class Reference

#include <SDIFIn.hxx>

List of all members.

Public Member Functions

 SDIFIn (const SDIFInConfig &c)
 SDIFIn ()
virtual ~SDIFIn ()
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 (CLAM::Segment &segment)
const ProcessingConfig & GetConfig () const
 Configuration getter.

Public Attributes

OutPort< Segment > mOutput

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.
bool LoadSDIFDataIntoSegment (CLAM::Segment &s)

Detailed Description

Definition at line 36 of file SDIFIn.hxx.

Constructor & Destructor Documentation

CLAM::SDIFIn::SDIFIn ( const SDIFInConfig &  c  ) 

Definition at line 51 of file SDIFIn.cxx.

References CLAM::Processing::Configure().

CLAM::SDIFIn::SDIFIn (  ) 

Definition at line 41 of file SDIFIn.cxx.

References CLAM::Processing::Configure().

CLAM::SDIFIn::~SDIFIn (  )  [virtual]

Definition at line 61 of file SDIFIn.cxx.

Member Function Documentation

bool CLAM::SDIFIn::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 74 of file SDIFIn.cxx.

bool CLAM::SDIFIn::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 79 of file SDIFIn.cxx.

bool CLAM::SDIFIn::Do ( CLAM::Segment &  segment  ) 

Definition at line 131 of file SDIFIn.cxx.

References LoadSDIFDataIntoSegment().

bool CLAM::SDIFIn::Do ( void   )  [virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 141 of file SDIFIn.cxx.

References CLAM::OutPort< Token >::GetData(), LoadSDIFDataIntoSegment(), and mOutput.

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

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

Implements CLAM::Processing.

Definition at line 45 of file SDIFIn.hxx.

const ProcessingConfig & CLAM::SDIFIn::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 84 of file SDIFIn.cxx.

bool CLAM::SDIFIn::GetEnableFundFreq (  )  [inline]

Definition at line 49 of file SDIFIn.hxx.

bool CLAM::SDIFIn::GetEnablePeakArray (  )  [inline]

Definition at line 48 of file SDIFIn.hxx.

bool CLAM::SDIFIn::GetEnableResidual (  )  [inline]

Definition at line 47 of file SDIFIn.hxx.

bool CLAM::SDIFIn::LoadSDIFDataIntoSegment ( CLAM::Segment &  s  )  [protected]

Definition at line 89 of file SDIFIn.cxx.

References CLAM::Segment::AddFrame(), CLAM::SDIFFileReader::GetSamplingRate(), CLAM::SDIFFileReader::ReadFrame(), and CLAM::DynamicType::UpdateData().

Referenced by Do().

Member Data Documentation

OutPort<Segment> CLAM::SDIFIn::mOutput

Definition at line 57 of file SDIFIn.hxx.

Referenced by Do().

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