CLAM::Instrument Class Reference

#include <Instrument.hxx>

List of all members.

Public Member Functions
void	SetId (int id)
	Instrument ()
void	LinkStateOutWithInControl (Processing *inProc, unsigned inId)
void	UpdateState (TControlData value)
void	UpdateNote (TControlData value)
void	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
FloatInControl	mStateIn
FloatInControl	mNoteIn
FloatInControl	mVelocityIn
FloatOutControl	mStateOut
FloatOutControl	mNoteOut
FloatOutControl	mVelocityOut
Friends
class	Dispatcher

---

Detailed Description

Definition at line 34 of file Instrument.hxx.

---

Constructor & Destructor Documentation

CLAM::Instrument::Instrument

(

)

[inline]

Definition at line 59 of file Instrument.hxx.

---

Member Function Documentation

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 101 of file Instrument.hxx.

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

virtual bool CLAM::Instrument::Do

(

Audio &

audio

)

[pure virtual]

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 107 of file Instrument.hxx.

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

Definition at line 72 of file Instrument.hxx.

References CLAM::OutControlBase::AddLink(), CLAM::Processing::GetInControl(), and CLAM::Processing::GetOutControl().

void CLAM::Instrument::SetId

(

int

id

)

[inline]

Definition at line 57 of file Instrument.hxx.

void CLAM::Instrument::UpdateNote

(

TControlData

value

)

[inline]

Definition at line 89 of file Instrument.hxx.

References mNoteOut, and CLAM::OutControl< ControlDataType >::SendControl().

void CLAM::Instrument::UpdateState

(

TControlData

value

)

[inline]

Definition at line 78 of file Instrument.hxx.

References mStateOut, and CLAM::OutControl< ControlDataType >::SendControl().

void CLAM::Instrument::UpdateVel

(

TControlData

value

)

[inline]

Definition at line 94 of file Instrument.hxx.

References mVelocityOut, and CLAM::OutControl< ControlDataType >::SendControl().

---

Friends And Related Function Documentation

friend class Dispatcher [friend]

Definition at line 55 of file Instrument.hxx.

---

Member Data Documentation

FloatInControl CLAM::Instrument::mNoteIn [protected]

Definition at line 47 of file Instrument.hxx.

FloatOutControl CLAM::Instrument::mNoteOut [protected]

Definition at line 51 of file Instrument.hxx.

Referenced by UpdateNote().

FloatInControl CLAM::Instrument::mStateIn [protected]

Definition at line 46 of file Instrument.hxx.

FloatOutControl CLAM::Instrument::mStateOut [protected]

Definition at line 50 of file Instrument.hxx.

Referenced by UpdateState().

FloatInControl CLAM::Instrument::mVelocityIn [protected]

Definition at line 48 of file Instrument.hxx.

FloatOutControl 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