CLAM-Development  1.4.0
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.
void DoClock (TControlData val)
- Public Member Functions inherited from CLAM::Processing
bool Configure (const ProcessingConfig &config)
 Configuration change method.
void Start (void)
 Method to turn the object into running state.
void Stop (void)
 Method to put the object out of running state When in execution mode, this method must be called before any further call to Configure() methods.
 Processing ()
virtual ~Processing ()
virtual bool CanProcessInplace ()
 Override this method if your processing cannot process inplace.
bool CanConsumeAndProduce ()
 Check that Supervised Do() can be safely called.
void ConsumeAndProduce ()
 Acknoledges data tokens in published ports as read/writen by calling Produce() for all registered OutPorts and Consume() to all registered InPorts.
std::string GetExecStateString () const
bool IsConfigured () const
bool IsRunning () const
void RegisterOutPort (OutPortBase *out)
void RegisterInPort (InPortBase *in)
void RegisterOutControl (OutControlBase *out)
void RegisterInControl (InControlBase *in)
void SetParent (Processing *p)
void SetNetworkBackLink (Network *network)
virtual bool ModifiesPortsAndControlsAtConfiguration ()
 This method is used to determine if a given processing can change its interface of ports/controls after its construction (i.e.
bool HasInPort (const std::string &name)
bool HasOutPort (const std::string &name)
bool HasInControl (const std::string &name)
bool HasOutControl (const std::string &name)
InPortBaseGetInPort (const std::string &name)
OutPortBaseGetOutPort (const std::string &name)
InControlBaseGetInControl (const std::string &name)
OutControlBaseGetOutControl (const std::string &name)
InPortBaseGetInPort (unsigned index)
OutPortBaseGetOutPort (unsigned index)
InControlBaseGetInControl (unsigned index)
OutControlBaseGetOutControl (unsigned index)
unsigned GetNInPorts () const
unsigned GetNOutPorts () const
unsigned GetNInControls () const
unsigned GetNOutControls () const
const std::string & GetConfigErrorMessage () const
 Returns a string describing configuration errors if any.
virtual bool IsSyncSource () const
 Wether the processing is a sync source such as audio i/o device, or an audio callback hook (i.e.
virtual bool SupportsVariableAudioSize () const
 This method reports whether the processing supports dynamic buffer-size host.

Protected Member Functions

bool ConcreteStart (void)
 Processing objects have to redefine this method when starting them implies some internal changes.
- Protected Member Functions inherited from CLAM::Processing
virtual bool ConcreteStop ()
 Processing objects have to redefine this method when stoping them implies some internal changes.
unsigned BackendBufferSize ()
 Given by the NetworkPlayer (backend) if exists.
unsigned BackendSampleRate ()
 Given by the NetworkPlayer (backend) if exists.
InControlRegistryGetInControls ()
 Accessor to published Controls manager.
OutControlRegistryGetOutControls ()
 Accessor to published Controls manager.
InPortRegistryGetInPorts ()
 Accessor to published Ports manager.
OutPortRegistryGetOutPorts ()
 Accessor to published Portss manager.
bool AddConfigErrorMessage (const std::string &msg)
 Use this method to append a configuration errors to the processing when implementing ConcreteConfigure.
bool AbleToExecute (void) const
 In debug-mode checks that the processing is configured and started.
template<typename ConcreteConfig >
void CopyAsConcreteConfig (ConcreteConfig &concrete, const ProcessingConfig &abstract) const
 Helper template to convert a reference to a ProcessingConfig to the concrete ProcessingConfig specified on the first parameter.
void SetExecState (ExecState state)

Protected Attributes

MIDIClockerConfig mConfig
MIDIDevicempDevice
FloatInControl mInput
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Friends

class MIDIManager
class MIDIDevice

Additional Inherited Members

- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config

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

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:
cThe 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:
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  )
protectedvirtual

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  )
inlinevirtual

Non supervised mode of Do function.

Non implemented yet

Implements CLAM::Processing.

Definition at line 110 of file MIDIClocker.hxx.

void CLAM::MIDIClocker::DoClock ( TControlData  val)
inline

Definition at line 124 of file MIDIClocker.hxx.

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

const char* CLAM::MIDIClocker::GetClassName ( ) const
inlinevirtual

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
inlinevirtual

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.

void CLAM::MIDIClocker::GetDeviceInfo ( MIDIDevice::TInfo info) const

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

MIDIClockerConfig CLAM::MIDIClocker::mConfig
protected

Definition at line 67 of file MIDIClocker.hxx.

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

FloatInControl CLAM::MIDIClocker::mInput
protected

Definition at line 69 of file MIDIClocker.hxx.

MIDIDevice* CLAM::MIDIClocker::mpDevice
protected

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