CLAM-Development  1.1
Public Member Functions | Protected Member Functions | Protected Attributes | Friends
CLAM::MIDIClocker Class Reference

This class is the interface to an input of an MIDIDevice. More...

#include <MIDIClocker.hxx>

List of all members.

Public Member Functions

virtual bool ConcreteConfigure (const ProcessingConfig &c) throw (ErrProcessingObj)
 Configuration method interface.
const ProcessingConfigGetConfig () 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
MIDIDevicempDevice
InControlTmpl< MIDIClockermInput

Friends

class MIDIManager
class MIDIDevice

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.


Constructor & Destructor Documentation

Definition at line 86 of file MIDIClocker.hxx.

References CLAM::Processing::Configure(), and mpDevice.

Constructor of the class with an MIDIIOConfig object constructed by the user as parameter.

Parameters:
cThe concrete MIDIIOConfig that will be used for this construction

Definition at line 96 of file MIDIClocker.hxx.

References CLAM::Processing::Configure(), and mpDevice.

Destructor of the class.

Definition at line 104 of file MIDIClocker.hxx.

References mpDevice, and CLAM::MIDIDevice::Unregister().


Member Function Documentation

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:
Therelated ProcessingConfig object
Exceptions:
ErrProcessingObjwhen 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().

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

Starting the MIDIDevice object assigned to the MIDIClocker

Reimplemented from CLAM::Processing.

Definition at line 71 of file MIDIClocker.cxx.

References mpDevice, and CLAM::MIDIDevice::Start().

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.

Definition at line 124 of file MIDIClocker.hxx.

References mpDevice, and CLAM::MIDIDevice::SetClock().

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.

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.

Getter for the Info of Device Object attached to this MIDIClocker instantiation.

Parameters:
infoTInfo 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().


Friends And Related Function Documentation

friend class MIDIDevice [friend]

Definition at line 65 of file MIDIClocker.hxx.

friend class MIDIManager [friend]

Definition at line 64 of file MIDIClocker.hxx.


Member Data Documentation

Definition at line 67 of file MIDIClocker.hxx.

Referenced by GetConfig(), and CLAM::MIDIManager::Register().

Definition at line 69 of file MIDIClocker.hxx.


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