---

syn::InstrumentModule Class Reference

an instrument is a group of modules connected in some way. More...

#include <InstrumentModule.h>

Inheritance diagram for syn::InstrumentModule:

[legend]Collaboration diagram for syn::InstrumentModule:

[legend]List of all members.

Public Methods
	InstrumentModule ()
	default constructor. More...
virtual	~InstrumentModule ()
	destructor. More...
virtual void	update ()
	defines this module's task (or frame) function. More...
virtual bool	open ()
	modules need to be opened before they are used. More...
virtual bool	isOpen ()
	check to see if the module is open. More...
virtual void	close ()
	close the module when done with it. More...
virtual Module*	clone () const
	get an exact copy of me. 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

an instrument is a group of modules connected in some way.

the instrument has the same interface as Module so that it is compatible with arbitrary Module networks.

Definition at line 43 of file InstrumentModule.h.

---

Constructor & Destructor Documentation

syn::InstrumentModule::InstrumentModule ( )

default constructor.

syn::InstrumentModule::~InstrumentModule ( ) [virtual]

destructor.

---

Member Function Documentation

void syn::InstrumentModule::update ( ) [inline, virtual]

defines this module's task (or frame) function. Reimplemented from syn::Module. Definition at line 53 of file InstrumentModule.h.

bool syn::InstrumentModule::open ( ) [inline, virtual]

modules need to be opened before they are used. Reimplemented from syn::Module. Definition at line 56 of file InstrumentModule.h.

bool syn::InstrumentModule::isOpen ( ) [inline, virtual]

check to see if the module is open. Definition at line 59 of file InstrumentModule.h.

void syn::InstrumentModule::close ( ) [inline, virtual]

close the module when done with it. Reimplemented from syn::Module. Definition at line 62 of file InstrumentModule.h.

Module * syn::InstrumentModule::clone ( ) const [inline, virtual]

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

void syn::InstrumentModule::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 74 of file InstrumentModule.h.

void syn::InstrumentModule::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 79 of file InstrumentModule.h.

---

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

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

---