#include <WaveGenerator.hxx>

Classes
class	EWaveType_eSine

Public Member Functions
TData	GetXPos () const
void	SetXPos (TData new_value)
TData	GetXDelta () const
void	SetXDelta (TData new_value)
TData	GetAmplitude () const
	WaveGenerator ()
	WaveGenerator (const WaveGeneratorConfig &c)
virtual	~WaveGenerator ()
const ProcessingConfig &	GetConfig () const
	Configuration access:
bool	Do (void)
	Supervised-mode Do function.
bool	Do (Audio &in)
	Standard Do function, with storage class references as arguments.
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)
InPortBase &	GetInPort (const std::string &name)
OutPortBase &	GetOutPort (const std::string &name)
InControlBase &	GetInControl (const std::string &name)
OutControlBase &	GetOutControl (const std::string &name)
InPortBase &	GetInPort (unsigned index)
OutPortBase &	GetOutPort (unsigned index)
InControlBase &	GetInControl (unsigned index)
OutControlBase &	GetOutControl (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.

Public Attributes
OutPort< Audio >	Output

Protected Attributes
WaveGeneratorConfig	mConfig
Protected Attributes inherited from CLAM::Processing
ProcessingComposite *	mpParent
	Pointer to the parent (composite) processing object, or 0.
Network *	_network
	The parent network if any.

Additional Inherited Members
Public Types inherited from CLAM::Processing
enum	ExecState { Unconfigured = 0, Ready, Running }
	Processing Object possible execution states. More...
typedef NullProcessingConfig	Config
Protected Member Functions inherited from CLAM::Processing
virtual bool	ConcreteStart ()
	Processing objects have to redefine this method when starting them implies some internal changes.
virtual bool	ConcreteStop ()
	Processing objects have to redefine this method when stoping them implies some internal changes.
unsigned	BackendBufferSize ()
	Given by the NetworkPlayer (backend) if exists.
unsigned	BackendSampleRate ()
	Given by the NetworkPlayer (backend) if exists.
InControlRegistry &	GetInControls ()
	Accessor to published Controls manager.
OutControlRegistry &	GetOutControls ()
	Accessor to published Controls manager.
InPortRegistry &	GetInPorts ()
	Accessor to published Ports manager.
OutPortRegistry &	GetOutPorts ()
	Accessor to published Portss manager.
bool	AddConfigErrorMessage (const std::string &msg)
	Use this method to append a configuration errors to the processing when implementing ConcreteConfigure.
bool	AbleToExecute (void) const
	In debug-mode checks that the processing is configured and started.
template<typename ConcreteConfig >
void	CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const
	Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter.
void	SetExecState (ExecState state)

Detailed Description

Definition at line 78 of file WaveGenerator.hxx.

Constructor & Destructor Documentation

CLAM::WaveGenerator::WaveGenerator ( )

Definition at line 50 of file WaveGenerator.cxx.

References CLAM::Processing::Configure().

CLAM::WaveGenerator::WaveGenerator ( const WaveGeneratorConfig & c )

Definition at line 56 of file WaveGenerator.cxx.

References CLAM::Processing::Configure().

CLAM::WaveGenerator::~WaveGenerator ( )

virtual

Definition at line 81 of file WaveGenerator.cxx.

Member Function Documentation

bool CLAM::WaveGenerator::Do ( void )

virtual

Supervised-mode Do function.

Implements CLAM::Processing.

Definition at line 100 of file WaveGenerator.cxx.

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

bool CLAM::WaveGenerator::Do ( Audio & in )

Standard Do function, with storage class references as arguments.

This method implements the old conversor routines.

Definition at line 85 of file WaveGenerator.cxx.

References CLAM::EWaveType::eSine.

TData CLAM::WaveGenerator::GetAmplitude ( ) const

inline

Definition at line 129 of file WaveGenerator.hxx.

Referenced by CLAM::FillBuffer().

const ProcessingConfig& CLAM::WaveGenerator::GetConfig ( ) const

inlinevirtual

Configuration access:

Reimplemented from CLAM::Processing.

Definition at line 144 of file WaveGenerator.hxx.

References mConfig.

TData CLAM::WaveGenerator::GetXDelta ( ) const

inline

Definition at line 119 of file WaveGenerator.hxx.

Referenced by CLAM::FillBuffer().

TData CLAM::WaveGenerator::GetXPos ( ) const

inline

Definition at line 109 of file WaveGenerator.hxx.

Referenced by CLAM::FillBuffer().

void CLAM::WaveGenerator::SetXDelta ( TData new_value )

inline

Definition at line 124 of file WaveGenerator.hxx.

void CLAM::WaveGenerator::SetXPos ( TData new_value )

inline

Definition at line 114 of file WaveGenerator.hxx.

Referenced by CLAM::FillBuffer().

Member Data Documentation

WaveGeneratorConfig CLAM::WaveGenerator::mConfig

protected

Definition at line 81 of file WaveGenerator.hxx.

Referenced by GetConfig().

OutPort<Audio> CLAM::WaveGenerator::Output

Definition at line 134 of file WaveGenerator.hxx.

Referenced by Do().

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

Classes

Public Member Functions

Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation