Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Namespace Members | Compound Members | File Members

TSE3::MidiParams Class Reference

A collection of MIDI parameter values. More...

#include <MidiParams.h>

Inheritance diagram for TSE3::MidiParams:

Inheritance graph
[legend]
Collaboration diagram for TSE3::MidiParams:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 MidiParams ()
 MidiParams (const MidiParams &)
virtual ~MidiParams ()
MidiParamsoperator= (const MidiParams &)
int bankLSB () const
void setBankLSB (int b)
int bankMSB () const
void setBankMSB (int b)
int program () const
void setProgram (int p)
int pan () const
void setPan (int p)
int reverb () const
void setReverb (int r)
int chorus () const
void setChorus (int c)
int volume () const
void setVolume (int v)
virtual PlayableIteratoriterator (Clock index)
virtual Clock lastClock () const
virtual void save (std::ostream &o, int i) const
virtual void load (std::istream &in, SerializableLoadInfo &info)
virtual MidiEvent filter (const MidiEvent &e) const

Static Public Attributes

const int off = -1
const int forceNone = -2

Detailed Description

A collection of MIDI parameter values.

The MidiParams class holds values for MIDI parameters used by several of the TSE3 classes.

The parameters it defines can generally be assigned values, not assigned values or forced to not allow any changes in these values at all.

For this reason, MidiParams implements both the Playable and Filter interfaces.

Command classes
Use the following command classes to manipute this object in a undo/redo environment.

Author:
Pete Goodliffe
Version:
3.00


Constructor & Destructor Documentation

TSE3::MidiParams::MidiParams  ) 
 

The default MidiParams has all parameters set to 'off'.

TSE3::MidiParams::MidiParams const MidiParams  ) 
 

virtual TSE3::MidiParams::~MidiParams  )  [virtual]
 


Member Function Documentation

MidiParams& TSE3::MidiParams::operator= const MidiParams  ) 
 

int TSE3::MidiParams::bankLSB  )  const [inline]
 

Read the bankLSB value.

Returns:
Bank select LSB value
See also:
setBankLSB

void TSE3::MidiParams::setBankLSB int  b  ) 
 

Set the bankLSB value.

Parameters:
b New bank select LSB value
See also:
bankLSB

int TSE3::MidiParams::bankMSB  )  const [inline]
 

Read the bankMSB value.

Returns:
Bank select MSB value
See also:
setBankMSB

void TSE3::MidiParams::setBankMSB int  b  ) 
 

Set the bankMSB value.

Parameters:
b New bank select MSB value
See also:
bankMSB

int TSE3::MidiParams::program  )  const [inline]
 

Read the program value.

Returns:
Program value
See also:
setProgram

void TSE3::MidiParams::setProgram int  p  ) 
 

Set the program value.

Parameters:
p New program value
See also:
program

int TSE3::MidiParams::pan  )  const [inline]
 

Read the pan value.

Returns:
Pan value
See also:
setPan

void TSE3::MidiParams::setPan int  p  ) 
 

Set the pan value.

Parameters:
p New pan value
See also:
pan

int TSE3::MidiParams::reverb  )  const [inline]
 

Read the reverb value.

Returns:
Reverb value
See also:
setReverb

void TSE3::MidiParams::setReverb int  r  ) 
 

Set the reverb value.

Parameters:
r New reverb value
See also:
reverb

int TSE3::MidiParams::chorus  )  const [inline]
 

Read the chorus value.

Returns:
Chorus value
See also:
setChorus

void TSE3::MidiParams::setChorus int  c  ) 
 

Set the chorus value.

Parameters:
c New chorus value
See also:
chorus

int TSE3::MidiParams::volume  )  const [inline]
 

Read the volume value.

Returns:
Volume value
See also:
setVolume

void TSE3::MidiParams::setVolume int  v  ) 
 

Set the volume value.

Parameters:
v New volume value
See also:
volume

virtual PlayableIterator* TSE3::MidiParams::iterator Clock  index  )  [virtual]
 

Implements TSE3::Playable.

virtual Clock TSE3::MidiParams::lastClock  )  const [virtual]
 

Implements TSE3::Playable.

virtual void TSE3::MidiParams::save std::ostream &  o,
int  i
const [virtual]
 

Reimplemented from TSE3::Serializable.

virtual void TSE3::MidiParams::load std::istream &  in,
SerializableLoadInfo info
[virtual]
 

Reimplemented from TSE3::Serializable.

virtual MidiEvent TSE3::MidiParams::filter const MidiEvent e  )  const [virtual]
 

Implements TSE3::Filter.


Member Data Documentation

const int TSE3::MidiParams::off = -1 [static]
 

A parameter is set to this value to switch it's effect off.

const int TSE3::MidiParams::forceNone = -2 [static]
 

A parameter is set to this value to prevent any changes in it occurring.


The documentation for this class was generated from the following file:
Generated on Wed May 25 14:46:33 2005 for TSE3 by doxygen 1.3.2