---

syn::OperatorModule Class Template Reference

combines two inputs using an operation. More...

#include <OperatorModule.h>

Inheritance diagram for syn::OperatorModule:

[legend]Collaboration diagram for syn::OperatorModule:

[legend]List of all members.

Public Methods
	OperatorModule ()
virtual	~OperatorModule ()
virtual void	update ()
virtual bool	open ()
	open the stream and set the audio format of this module read from the stream(s) by getting the right output terminal. More...
virtual bool	isOpen ()
virtual void	close ()
virtual Module*	clone () const
	get an exact copy of me. More...
void	setConstant (float constant)
	when only one input is attached, use this scalar value in place of the missing input terminal. More...
float	constant () const
	get the constant. More...
parameter access
virtual void	getParam (const std::string &key, MultivariateType &value)
	a way to get module params without knowing the real funcs. More...
virtual void	setParam (const std::string &key, const MultivariateType &value)
	a way to set module params without knowing the real funcs. More...

---

Detailed Description

template<typename OPERATOR> class syn::OperatorModule

combines two inputs using an operation.

There are a few predefined operators you can use:

• syn::Math::ADDEQUAL
• syn::Math::MULTEQUAL
• syn::Math::EQUAL

can also modify a single input with a scalar value. The operator operates on the two inputs in this way:

• [mono audio0] op [mono audio1]

In the case of only one input terminal connected, a constant is used:

• [mono audio0] op constant

Operators are defined as follows: struct OPER { inline static void oper( float&, const float ); }

Definition at line 61 of file OperatorModule.h.

---

Constructor & Destructor Documentation

template<typename OPERATOR> syn::OperatorModule<OPERATOR>::OperatorModule<OPERATOR> ( ) [inline]

Definition at line 64 of file OperatorModule.h.

template<typename OPERATOR> syn::OperatorModule<OPERATOR>::~OperatorModule<OPERATOR> ( ) [inline, virtual]

Definition at line 75 of file OperatorModule.h.

---

Member Function Documentation

template<typename OPERATOR> void syn::OperatorModule< OPERATOR >::update ( ) [inline, virtual]

Reimplemented from syn::Module. Definition at line 141 of file OperatorModule.h.

template<typename OPERATOR> bool syn::OperatorModule<OPERATOR>::open ( ) [inline, virtual]

open the stream and set the audio format of this module read from the stream(s) by getting the right output terminal. Reimplemented from syn::Module. Definition at line 77 of file OperatorModule.h.

template<typename OPERATOR> bool syn::OperatorModule<OPERATOR>::isOpen ( ) [inline, virtual]

Definition at line 78 of file OperatorModule.h.

template<typename OPERATOR> void syn::OperatorModule<OPERATOR>::close ( ) [inline, virtual]

Reimplemented from syn::Module. Definition at line 79 of file OperatorModule.h.

template<typename OPERATOR> Module * syn::OperatorModule<OPERATOR>::clone ( ) const [inline, virtual]

get an exact copy of me. Reimplemented from syn::Module. Definition at line 84 of file OperatorModule.h.

template<typename OPERATOR> void syn::OperatorModule<OPERATOR>::setConstant ( float constant ) [inline]

when only one input is attached, use this scalar value in place of the missing input terminal. Definition at line 94 of file OperatorModule.h. Referenced by setParam().

template<typename OPERATOR> float syn::OperatorModule<OPERATOR>::constant ( ) const [inline]

get the constant. Definition at line 100 of file OperatorModule.h.

template<typename OPERATOR> void syn::OperatorModule<OPERATOR>::getParam ( const std::string & key, MultivariateType & value ) [inline, virtual]

a way to get module params without knowing the real funcs. Reimplemented from syn::Module. Definition at line 105 of file OperatorModule.h.

template<typename OPERATOR> void syn::OperatorModule<OPERATOR>::setParam ( const std::string & key, const MultivariateType & value ) [inline, virtual]

a way to set module params without knowing the real funcs. Reimplemented from syn::Module. Definition at line 112 of file OperatorModule.h.

---

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

• /root/src/subsynth/syn/Module/OperatorModule.h

---