CLAM-Development  1.4.0
Public Member Functions
CLAM::SMSSineFilter Class Reference

#include <SMSSineFilter.hxx>

List of all members.

Public Member Functions

 SMSSineFilter ()
 Base constructor of class.
 SMSSineFilter (const FrameTransformationConfig &cfg)
 Constructor with an object of SegmentTransformationConfig class by parameter.
virtual bool ConcreteConfigure (const ProcessingConfig &cfg)
 Configuration method interface.
const ProcessingConfigGetConfig () const
 Configuration getter.
 ~SMSSineFilter ()
 Destructor of the class.
bool Do (const Frame &in, Frame &out)
bool Do (const SpectralPeakArray &in, SpectralPeakArray &out)
bool Do ()
 Supervised mode execution method (using ports)
void InitBPF ()
- Public Member Functions inherited from CLAM::FrameTransformation
 FrameTransformation ()
virtual bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
virtual bool InitControls ()
 Virtual function to override when needing to give different default values to the controls.
- Public Member Functions inherited from CLAM::Processing
bool Configure (const ProcessingConfig &config)
 Configuration change method.
void Start (void)
 Method to turn the object into running state.
void Stop (void)
 Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods.
 Processing ()
virtual ~Processing ()
virtual bool CanProcessInplace ()
 Override this method if your processing cannot process inplace.
bool CanConsumeAndProduce ()
 Check that Supervised Do() can be safely called.
void ConsumeAndProduce ()
 Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts.
std::string GetExecStateString () const
bool IsConfigured () const
bool IsRunning () const
void RegisterOutPort (OutPortBase *out)
void RegisterInPort (InPortBase *in)
void RegisterOutControl (OutControlBase *out)
void RegisterInControl (InControlBase *in)
void SetParent (Processing *p)
void SetNetworkBackLink (Network *network)
virtual bool ModifiesPortsAndControlsAtConfiguration ()
 This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.
bool HasInPort (const std::string &name)
bool HasOutPort (const std::string &name)
bool HasInControl (const std::string &name)
bool HasOutControl (const std::string &name)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (unsigned index)
unsigned GetNInPorts () const
unsigned GetNOutPorts () const
unsigned GetNInControls () const
unsigned GetNOutControls () const
const std::string & GetConfigErrorMessage () const
 Returns a string describing configuration errors if any.
virtual bool IsSyncSource () const
 Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e.
virtual bool SupportsVariableAudioSize () const
 This method reports whether the processing supports dynamic buffer-size host.

Additional Inherited Members

- Protected Attributes inherited from CLAM::FrameTransformation
FrameTransformationConfig mConfig
FloatInControl mAmount
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

Definition at line 68 of file SMSSineFilter.hxx.


Constructor & Destructor Documentation

CLAM::SMSSineFilter::SMSSineFilter ( )
inline

Base constructor of class.

Calls Configure method with a SegmentTransformationConfig initialised by default

Definition at line 97 of file SMSSineFilter.hxx.

References CLAM::Processing::Configure(), CLAM::FrameTransformation::mConfig, and CLAM::DynamicType::UpdateData().

CLAM::SMSSineFilter::SMSSineFilter ( const FrameTransformationConfig cfg)
inline

Constructor with an object of SegmentTransformationConfig class by parameter.

Parameters:
cSegmentTransformationConfig object created by the user

Definition at line 114 of file SMSSineFilter.hxx.

References CLAM::Processing::Configure().

CLAM::SMSSineFilter::~SMSSineFilter ( )
inline

Destructor of the class.

Definition at line 134 of file SMSSineFilter.hxx.


Member Function Documentation

virtual bool CLAM::SMSSineFilter::ConcreteConfigure ( const ProcessingConfig )
inlinevirtual

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:
Referenceto 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:
Thismethod 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 124 of file SMSSineFilter.hxx.

References CLAM::Processing::CopyAsConcreteConfig(), InitBPF(), and CLAM::FrameTransformation::mConfig.

bool CLAM::SMSSineFilter::Do ( const Frame in,
Frame out 
)
inlinevirtual

Implements CLAM::FrameTransformation.

Definition at line 137 of file SMSSineFilter.hxx.

References Do().

bool CLAM::SMSSineFilter::Do ( const SpectralPeakArray in,
SpectralPeakArray out 
)
bool CLAM::SMSSineFilter::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 145 of file SMSSineFilter.hxx.

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

Referenced by Do().

const ProcessingConfig& CLAM::SMSSineFilter::GetConfig ( ) const
inlinevirtual

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::FrameTransformation.

Definition at line 131 of file SMSSineFilter.hxx.

References CLAM::FrameTransformation::mConfig.

void CLAM::SMSSineFilter::InitBPF ( )
inline

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