CLAM::MIDIClocker Class Reference
#include <MIDIClocker.hxx>
Detailed Description
This class is the interface to an input of an MIDIDevice.
- See also:
- Processing, MIDIClockerConfig, MIDIOut, MIDIManager, MIDIDevice
Definition at line 62 of file MIDIClocker.hxx.
Public Member Functions | |
| virtual bool | ConcreteConfigure (const ProcessingConfig &c) throw (ErrProcessingObj) |
| Configuration method interface. | |
| const ProcessingConfig & | GetConfig () const |
| Getter for the configuration of the class. | |
| MIDIClocker () | |
| MIDIClocker (const MIDIClockerConfig &c) | |
| Constructor of the class with an MIDIIOConfig object constructed by the user as parameter. | |
| ~MIDIClocker () | |
| Destructor of the class. | |
| const char * | GetClassName () const |
| Override it in every subclass and retur the name of that class. | |
| bool | Do (void) |
| Non supervised mode of Do function. | |
| void | GetDeviceInfo (MIDIDevice::TInfo &) const |
| Getter for the Info of Device Object attached to this MIDIClocker instantiation. | |
| int | DoClock (TControlData val) |
Protected Member Functions | |
| bool | ConcreteStart (void) |
| Processing objects have to redefine this method when starting them implies some internal changes. | |
Protected Attributes | |
| MIDIClockerConfig | mConfig |
| MIDIDevice * | mpDevice |
| InControlTmpl< MIDIClocker > | mInput |
Friends | |
| class | MIDIManager |
| class | MIDIDevice |
Constructor & Destructor Documentation
| CLAM::MIDIClocker::MIDIClocker | ( | ) | [inline] |
Definition at line 86 of file MIDIClocker.hxx.
References CLAM::Processing::Configure(), and mpDevice.
| CLAM::MIDIClocker::MIDIClocker | ( | const MIDIClockerConfig & | c | ) | [inline] |
Constructor of the class with an MIDIIOConfig object constructed by the user as parameter.
- Parameters:
-
c The concrete MIDIIOConfig that will be used for this construction
Definition at line 96 of file MIDIClocker.hxx.
References CLAM::Processing::Configure(), and mpDevice.
| CLAM::MIDIClocker::~MIDIClocker | ( | ) | [inline] |
Destructor of the class.
Definition at line 104 of file MIDIClocker.hxx.
References mpDevice, and CLAM::MIDIDevice::Unregister().
Member Function Documentation
| bool CLAM::MIDIClocker::ConcreteConfigure | ( | const ProcessingConfig & | c | ) | throw (ErrProcessingObj) [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
- Exceptions:
-
ErrProcessingObj when there is an error on device adquisition
Unregistering a possible device already assigned to the MIDIClocker object
Getting the MIDIManager object
Registering the MIDIClocker object through the MIDIManager object
Reimplemented from CLAM::Processing.
Definition at line 29 of file MIDIClocker.cxx.
References CLAM::MIDIManager::Current(), CLAM::Err::Embed(), and CLAM::MIDIManager::Register().
| const ProcessingConfig& CLAM::MIDIClocker::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 84 of file MIDIClocker.hxx.
References mConfig.
| const char* CLAM::MIDIClocker::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 106 of file MIDIClocker.hxx.
| bool CLAM::MIDIClocker::Do | ( | void | ) | [inline, virtual] |
Non supervised mode of Do function.
Non implemented yet
Implements CLAM::Processing.
Definition at line 110 of file MIDIClocker.hxx.
| void CLAM::MIDIClocker::GetDeviceInfo | ( | MIDIDevice::TInfo & | info | ) | const |
Getter for the Info of Device Object attached to this MIDIClocker instantiation.
- Parameters:
-
info TInfo object that method will modify with the values of Tinfo internal object
Definition at line 80 of file MIDIClocker.cxx.
References CLAM::MIDIDevice::GetInfo(), mpDevice, and CLAM::MIDIDevice::TInfo::Reset().
| int CLAM::MIDIClocker::DoClock | ( | TControlData | val | ) | [inline] |
Definition at line 124 of file MIDIClocker.hxx.
References mpDevice, and CLAM::MIDIDevice::SetClock().
| bool CLAM::MIDIClocker::ConcreteStart | ( | void | ) | [protected, virtual] |
Processing objects have to redefine this method when starting them implies some internal changes.
ie: adquiring resources.
- Returns:
- Whether start changes have been successful
Reimplemented from CLAM::Processing.
Definition at line 71 of file MIDIClocker.cxx.
References mpDevice, and CLAM::MIDIDevice::Start().
Friends And Related Function Documentation
friend class MIDIManager [friend] |
Definition at line 64 of file MIDIClocker.hxx.
friend class MIDIDevice [friend] |
Definition at line 65 of file MIDIClocker.hxx.
Member Data Documentation
MIDIClockerConfig CLAM::MIDIClocker::mConfig [protected] |
Definition at line 67 of file MIDIClocker.hxx.
Referenced by GetConfig(), and CLAM::MIDIManager::Register().
MIDIDevice* CLAM::MIDIClocker::mpDevice [protected] |
Definition at line 68 of file MIDIClocker.hxx.
Referenced by ConcreteStart(), DoClock(), GetDeviceInfo(), MIDIClocker(), CLAM::MIDIDevice::Register(), CLAM::MIDIDevice::Unregister(), and ~MIDIClocker().
InControlTmpl<MIDIClocker> CLAM::MIDIClocker::mInput [protected] |
Definition at line 69 of file MIDIClocker.hxx.
The documentation for this class was generated from the following files:
