CLAM::PrintControl Class Reference

#include <PrintControl.hxx>

Inheritance diagram for CLAM::PrintControl:

CLAM::Processing

List of all members.


Detailed Description

A class useful to debug watching what kind of MIDI messages we are processing.

Prints in the screen the type of message, and its value. If the objective is control more than one type of data (i.e. Note On and Note Velocity), more than one PrintControl objects must be created.

See also:
Processing, PrintControlConfig

Definition at line 55 of file PrintControl.hxx.


Public Member Functions

 PrintControl (const PrintControlConfig &cfg)
 Constructor of the class.
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration method interface.
const ProcessingConfigGetConfig () const
 Getter for the configuration of the class.
int DoPrint (TControlData val)
 Method created to print in default screen the values of MIDI messages catched by the MIDIDevice.
bool Do (void)
 Supervised method, not implemented yet.

Public Attributes

InControlTmpl< PrintControlmInput

Constructor & Destructor Documentation

CLAM::PrintControl::PrintControl ( const PrintControlConfig cfg  )  [inline]

Constructor of the class.

Receives by parameter the configuration that will be used to create the object

Parameters:
cfg The configuration of the new object, created by the user

Definition at line 66 of file PrintControl.hxx.

References CLAM::Processing::Configure().


Member Function Documentation

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

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

Implements CLAM::Processing.

Definition at line 71 of file PrintControl.hxx.

bool CLAM::PrintControl::ConcreteConfigure ( const ProcessingConfig c  )  [inline, 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.

Returns:
true if the object has been configured correctly; true otherwise
Parameters:
The related ProcessingConfig object

Reimplemented from CLAM::Processing.

Definition at line 78 of file PrintControl.hxx.

References CLAM::Processing::CopyAsConcreteConfig().

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

Getter for the configuration of the class.

Returns:
The ProcessingConfig object attached to this Processing object

Reimplemented from CLAM::Processing.

Definition at line 87 of file PrintControl.hxx.

int CLAM::PrintControl::DoPrint ( TControlData  val  )  [inline]

Method created to print in default screen the values of MIDI messages catched by the MIDIDevice.

Each PrintControl object controls messages of only one kind and one value (two values are controlled by two objects), so this method will print the type of message and its value.

Parameters:
val The value received with this message
Returns:
1 if method has been executed correctly

Definition at line 93 of file PrintControl.hxx.

bool CLAM::PrintControl::Do ( void   )  [inline, virtual]

Supervised method, not implemented yet.

Implements CLAM::Processing.

Definition at line 100 of file PrintControl.hxx.


Member Data Documentation

Definition at line 61 of file PrintControl.hxx.


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

Generated on Tue Aug 12 22:33:47 2008 for CLAM by  doxygen 1.5.5