csl::Instrument Class Reference

#include <Instrument.h>

Inheritance diagram for csl::Instrument:

List of all members.

Public Member Functions
	Instrument ()
	Constructors.
	~Instrument ()
UnitGenerator *	graph ()
	Accessors.
UGenMap *	genMap ()
	my UGen graph
UGenVector *	envelopes ()
	the map of ugens in the graph by name
const string	name ()
	the vector of envelopes to query or trigger
UnitGenerator *	genNamed (string name)
	answer the number of channels
AccessorVector	getAccessors ()
	Accessor management.
unsigned	numAccessors ()
	answer the accessor vector
virtual void	setParameter (unsigned selector, int argc, void **argv, const char *types)
	answer the number of accessors
virtual void	nextBuffer (Buffer &outputBuffer) throw (CException)
	set a named parameter
virtual bool	isActive ()
	Envelope query and re-trigger.
virtual void	play ()
virtual void	playOSC (int argc, void **argv, const char *types)
virtual void	playNote (int argc, void **argv, const char *types)
	Play a note via a direct fcn call (subclasses refine this).
virtual void	release ()
Protected Attributes
UnitGenerator *	mGraph
	Caches.
string	mName
	my name
UGenMap	mUGens
	the map of ugens in the graph by name
UGenVector	mEnvelopes
	the vector of envelopes to query or trigger
AccessorVector	mAccessors
	the accessor vector

---

Detailed Description

Instrument class (abstract)

---

Constructor & Destructor Documentation

Instrument::Instrument

(

)

Constructors.

Instrument::~Instrument

(

)

---

Member Function Documentation

UnitGenerator* csl::Instrument::graph

(

)

[inline]

Accessors.

References mGraph.

UGenMap* csl::Instrument::genMap

(

)

[inline]

my UGen graph

References mUGens.

UGenVector* csl::Instrument::envelopes

(

)

[inline]

the map of ugens in the graph by name

References mEnvelopes.

const string csl::Instrument::name

(

)

[inline]

the vector of envelopes to query or trigger

References mName.

Referenced by setupOSCInstrLibrary().

UnitGenerator * Instrument::genNamed

(

string

name

)

answer the number of channels

answer my name get a UGen from the graph

References mUGens.

AccessorVector csl::Instrument::getAccessors

(

)

[inline]

Accessor management.

References mAccessors.

Referenced by setupOSCInstrLibrary().

unsigned csl::Instrument::numAccessors

(

)

[inline]

answer the accessor vector

References mAccessors.

Referenced by setupOSCInstrLibrary().

virtual void csl::Instrument::setParameter	(	unsigned	selector,
		int	argc,
		void **	argv,
		const char *	types
	)			[inline, virtual]

answer the number of accessors

Reimplemented in csl::AdditiveInstrument, csl::BasicFMInstrument, csl::FancyFMInstrument, and csl::SndFileInstrument.

Referenced by floatParamSetter(), intParamSetter(), paramSetter(), and stringParamSetter().

void Instrument::nextBuffer

(

Buffer &

outputBuffer

)

throw (CException) [virtual]

set a named parameter

get a UGen from the graph

Sample creation

Reimplemented from csl::UnitGenerator.

bool Instrument::isActive

(

)

[virtual]

Envelope query and re-trigger.

Reimplemented from csl::UnitGenerator.

References FALSE, csl::UnitGenerator::isActive(), mEnvelopes, mGraph, and TRUE.

void Instrument::play

(

)

[virtual]

Reimplemented in csl::SndFileInstrument, and csl::SampleBankInstrument.

References mEnvelopes.

Referenced by playNote(), csl::BasicFMInstrument::playNote(), csl::AdditiveInstrument::playNote(), csl::FancyFMInstrument::playOSC(), csl::BasicFMInstrument::playOSC(), and csl::AdditiveInstrument::playOSC().

virtual void csl::Instrument::playOSC	(	int	argc,
		void **	argv,
		const char *	types
	)			[inline, virtual]

Reimplemented in csl::AdditiveInstrument, csl::BasicFMInstrument, csl::FancyFMInstrument, csl::SndFileInstrument, and csl::SampleBankInstrument.

Referenced by playWithArgs().

virtual void csl::Instrument::playNote	(	int	argc,
		void **	argv,
		const char *	types
	)			[inline, virtual]

Play a note via a direct fcn call (subclasses refine this).

void Instrument::release

(

)

[virtual]

References mEnvelopes.

---

Member Data Documentation

UnitGenerator* csl::Instrument::mGraph [protected]

Caches.

my UGen graph

Referenced by csl::AdditiveInstrument::AdditiveInstrument(), csl::BasicFMInstrument::BasicFMInstrument(), graph(), csl::SndFileInstrument::initialize(), and isActive().

string csl::Instrument::mName [protected]

my name

Referenced by csl::AdditiveInstrument::AdditiveInstrument(), csl::BasicFMInstrument::BasicFMInstrument(), csl::FancyFMInstrument::FancyFMInstrument(), csl::VSTIO::getProgramName(), csl::SndFileInstrument::initialize(), name(), and csl::VSTIO::setProgramName().

UGenMap csl::Instrument::mUGens [protected]

the map of ugens in the graph by name

Referenced by csl::AdditiveInstrument::AdditiveInstrument(), csl::BasicFMInstrument::BasicFMInstrument(), csl::FancyFMInstrument::FancyFMInstrument(), genMap(), genNamed(), and csl::SndFileInstrument::initialize().

UGenVector csl::Instrument::mEnvelopes [protected]

the vector of envelopes to query or trigger

Referenced by csl::AdditiveInstrument::AdditiveInstrument(), csl::BasicFMInstrument::BasicFMInstrument(), envelopes(), csl::FancyFMInstrument::FancyFMInstrument(), isActive(), play(), and release().

AccessorVector csl::Instrument::mAccessors [protected]

the accessor vector

Referenced by csl::AdditiveInstrument::AdditiveInstrument(), csl::BasicFMInstrument::BasicFMInstrument(), getAccessors(), csl::SndFileInstrument::initialize(), and numAccessors().

---

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

• CSL/Instruments/Instrument.h
• CSL/Instruments/Instrument.cpp