CLAM::MIDIDispatcher Class Reference

#include <MIDIDispatcher.hxx>

List of all members.

Classes

struct  VoiceStatus

Public Member Functions

 MIDIDispatcher (const MIDIDispatcherConfig &cfg=MIDIDispatcherConfig())
bool ModifiesPortsAndControlsAtConfiguration ()
 This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.
virtual ~MIDIDispatcher ()
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfig & GetConfig () const
 Configuration getter.
bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration method interface.
bool Do ()
 Supervised mode execution method (using ports).

Protected Member Functions

void UpdateState (TControlData availableInstr)
void UpdateVel (TControlData value)
void UpdateNote (TControlData value)
void Dispatch ()

Detailed Description

Definition at line 47 of file MIDIDispatcher.hxx.

Constructor & Destructor Documentation

CLAM::MIDIDispatcher::MIDIDispatcher ( const MIDIDispatcherConfig &  cfg = MIDIDispatcherConfig()  ) 

Definition at line 47 of file MIDIDispatcher.cxx.

virtual CLAM::MIDIDispatcher::~MIDIDispatcher (  )  [inline, virtual]

Definition at line 100 of file MIDIDispatcher.hxx.

Member Function Documentation

bool CLAM::MIDIDispatcher::ConcreteConfigure ( const ProcessingConfig &   )  [virtual]

Configuration method interface.

The Processing base class forces all the concrete classes derived from it to implement this method, which must actually perform the specific configuration tasks.

Note that the user can not call this method directly. He will use Configure instead. The argument is expected to be an object of the necesary concrete configuration class.

Parameters:
Reference to the configuration object.
Returns:
false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:
This method must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 57 of file MIDIDispatcher.cxx.

void CLAM::MIDIDispatcher::Dispatch ( void   )  [protected]

Definition at line 85 of file MIDIDispatcher.cxx.

Referenced by UpdateNote().

bool CLAM::MIDIDispatcher::Do (  )  [inline, virtual]

Supervised mode execution method (using ports).

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 108 of file MIDIDispatcher.hxx.

const char* CLAM::MIDIDispatcher::GetClassName (  )  const [inline, virtual]

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

Implements CLAM::Processing.

Definition at line 102 of file MIDIDispatcher.hxx.

const ProcessingConfig& CLAM::MIDIDispatcher::GetConfig (  )  const [inline, virtual]

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:
Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Definition at line 104 of file MIDIDispatcher.hxx.

bool CLAM::MIDIDispatcher::ModifiesPortsAndControlsAtConfiguration (  )  [inline, virtual]

This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.

changing the name of ports in ConcreteConfigure). If a concrete processing can do this, it should reimplement the method returning true, in order to notify networks, graphical interfaces, etc.

Reimplemented from CLAM::Processing.

Definition at line 98 of file MIDIDispatcher.hxx.

void CLAM::MIDIDispatcher::UpdateNote ( TControlData  value  )  [inline, protected]

Definition at line 86 of file MIDIDispatcher.hxx.

References Dispatch().

void CLAM::MIDIDispatcher::UpdateState ( TControlData  availableInstr  )  [protected]

Definition at line 68 of file MIDIDispatcher.cxx.

void CLAM::MIDIDispatcher::UpdateVel ( TControlData  value  )  [inline, protected]

Definition at line 80 of file MIDIDispatcher.hxx.

The documentation for this class was generated from the following files:
Generated by  doxygen 1.6.3