CLAM::Instrument Class Reference

#include <Instrument.hxx>

Inheritance diagram for CLAM::Instrument:

List of all members.

---

Detailed Description

Definition at line 34 of file Instrument.hxx.

Public Member Functions
void	SetId (int id)
	Instrument ()
void	LinkStateOutWithInControl (Processing *inProc, unsigned inId)
int	UpdateState (TControlData value)
int	UpdateNote (TControlData value)
int	UpdateVel (TControlData value)
virtual bool	Do (Audio &audio)=0
bool	Do (void)
	Supervised mode execution method (using ports).
const char *	GetClassName () const
	Override it in every subclass and retur the name of that class.
Protected Attributes
InControlTmpl< Instrument >	mStateIn
InControlTmpl< Instrument >	mNoteIn
InControlTmpl< Instrument >	mVelocityIn
OutControl	mStateOut
OutControl	mNoteOut
OutControl	mVelocityOut
Friends
class	Dispatcher

---

Constructor & Destructor Documentation

CLAM::Instrument::Instrument

(

)

[inline]

Definition at line 59 of file Instrument.hxx.

---

Member Function Documentation

void CLAM::Instrument::SetId

(

int

id

)

[inline]

Definition at line 57 of file Instrument.hxx.

void CLAM::Instrument::LinkStateOutWithInControl	(	Processing *	inProc,
		unsigned	inId
	)			[inline]

Definition at line 72 of file Instrument.hxx.

References CLAM::OutControl::AddLink(), CLAM::InControlRegistry::GetByNumber(), CLAM::OutControlRegistry::GetByNumber(), CLAM::Processing::GetInControls(), and CLAM::Processing::GetOutControls().

int CLAM::Instrument::UpdateState

(

TControlData

value

)

[inline]

Definition at line 78 of file Instrument.hxx.

References mStateOut, and CLAM::OutControl::SendControl().

int CLAM::Instrument::UpdateNote

(

TControlData

value

)

[inline]

Definition at line 91 of file Instrument.hxx.

References mNoteOut, and CLAM::OutControl::SendControl().

int CLAM::Instrument::UpdateVel

(

TControlData

value

)

[inline]

Definition at line 98 of file Instrument.hxx.

References mVelocityOut, and CLAM::OutControl::SendControl().

virtual bool CLAM::Instrument::Do

(

Audio &

audio

)

[pure virtual]

bool CLAM::Instrument::Do

(

void

)

[inline, virtual]

Supervised mode execution method (using ports).

Returns:

A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 107 of file Instrument.hxx.

References CLAM::AudioOutPort::GetAudio(), and CLAM::OutPort< Token >::Produce().

const char* CLAM::Instrument::GetClassName

(

)

const [inline, virtual]

Override it in every subclass and retur the name of that class.

Reimplemented from CLAM::ProcessingComposite.

Definition at line 113 of file Instrument.hxx.

---

Friends And Related Function Documentation

friend class Dispatcher [friend]

Definition at line 55 of file Instrument.hxx.

---

Member Data Documentation

InControlTmpl< Instrument > CLAM::Instrument::mStateIn [protected]

Definition at line 46 of file Instrument.hxx.

InControlTmpl< Instrument > CLAM::Instrument::mNoteIn [protected]

Definition at line 47 of file Instrument.hxx.

InControlTmpl< Instrument > CLAM::Instrument::mVelocityIn [protected]

Definition at line 48 of file Instrument.hxx.

OutControl CLAM::Instrument::mStateOut [protected]

Definition at line 50 of file Instrument.hxx.

Referenced by UpdateState().

OutControl CLAM::Instrument::mNoteOut [protected]

Definition at line 51 of file Instrument.hxx.

Referenced by UpdateNote().

OutControl CLAM::Instrument::mVelocityOut [protected]

Definition at line 52 of file Instrument.hxx.

Referenced by UpdateVel().

---

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

• Instrument.hxx