MarSystemTemplateBasic Class Reference
[Processing]

Basic example on how to use controls efficiently in MarSystems. More...

#include <MarSystemTemplateBasic.h>

Inherits Marsyas::MarSystem.

Public Member Functions
MarSystem *	clone () const
	Implementation of the MarSystem::clone() method.
	MarSystemTemplateBasic (const MarSystemTemplateBasic &a)
	MarSystemTemplateBasic copy constructor.
	MarSystemTemplateBasic (std::string name)
	MarSystemTemplateBasic constructor.
void	myProcess (realvec &in, realvec &out)
	Implementation of the MarSystem::myProcess method.
	~MarSystemTemplateBasic ()
	MarSystemTemplateBasic destructor.
Private Member Functions
void	addControls ()
	Add specific controls needed by this MarSystem.
void	myUpdate (MarControlPtr sender)
	Reads changed controls and sets up variables if necessary.
Private Attributes
MarControlPtr	ctrl_gain_EXAMPLE_
	MarControlPtr for the gain control.

---

Detailed Description

Basic example on how to use controls efficiently in MarSystems.

This example is the same as Gain; it scales the output by multiplying each sample with a real number.

Controls:

• mrs_real/gain [w] : sets the gain multiplier.
• mrs_bool/dummy [rw] : does nothing.

Definition at line 39 of file MarSystemTemplateBasic.h.

---

Constructor & Destructor Documentation

MarSystemTemplateBasic

(

std::string

name

)

MarSystemTemplateBasic constructor.

Add any specific controls needed by this MarSystem.

Definition at line 25 of file MarSystemTemplateBasic.cpp.

References MarSystemTemplateBasic::addControls().

Referenced by MarSystemTemplateBasic::clone().

MarSystemTemplateBasic

(

const MarSystemTemplateBasic &

a

)

MarSystemTemplateBasic copy constructor.

All member MarControlPtr have to be explicitly reassigned in the copy constructor.

Definition at line 36 of file MarSystemTemplateBasic.cpp.

References MarSystemTemplateBasic::ctrl_gain_EXAMPLE_.

---

Member Function Documentation

void addControls

(

)

[private]

Add specific controls needed by this MarSystem.

Add any specific controls needed by this MarSystem.

Reimplemented from MarSystem.

Definition at line 58 of file MarSystemTemplateBasic.cpp.

References MarSystemTemplateBasic::ctrl_gain_EXAMPLE_.

Referenced by MarSystemTemplateBasic::MarSystemTemplateBasic().

void myProcess	(	realvec &	in,
		realvec &	out
	)			[virtual]

Implementation of the MarSystem::myProcess method.

Iterate over the observations and samples and do the processing.

Implements MarSystem.

Definition at line 96 of file MarSystemTemplateBasic.cpp.

References MarSystemTemplateBasic::ctrl_gain_EXAMPLE_.

void myUpdate

(

MarControlPtr

sender

)

[private, virtual]

Reads changed controls and sets up variables if necessary.

Use the default MarSystem setup with equal input/output stream format.

Reimplemented from MarSystem.

Definition at line 87 of file MarSystemTemplateBasic.cpp.

---

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

• /home/marsyas/marsyas/src/marsyas/MarSystemTemplateBasic.h
• /home/marsyas/marsyas/src/marsyas/MarSystemTemplateBasic.cpp