CLAM-Development  1.4.0
Public Member Functions
CLAM::MIDIOutControl Class Reference

#include <MIDIOutControl.hxx>

List of all members.

Public Member Functions

 MIDIOutControl ()
 MIDIOutControl (const MIDIIOConfig &c)
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool ConcreteConfigure (const ProcessingConfig &c) throw (ErrProcessingObj)
 Configuration method interface.
- Public Member Functions inherited from CLAM::MIDIOut
const ProcessingConfigGetConfig () const
 Getter for the configuration of the class.
 MIDIOut (bool configure=true)
 Constructor of the class with a boolean as parameter to choose whether to configure the object.
 MIDIOut (const MIDIIOConfig &c)
 Constructor of the class with an MIDIIOConfig object constructed by the user as parameter.
 ~MIDIOut ()
 Destructor unregisters this MIDIOut instance from the associated device.
bool Do (void)
 Non supervised mode of Do function.
void GetDeviceInfo (MIDIDevice::TInfo &) const
 Getter for the Info of Device Object attached to this MIDIOut instantiation.
- 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.

Additional Inherited Members

- Protected Member Functions inherited from CLAM::MIDIOut
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 inherited from CLAM::MIDIOut
MIDIIOConfig mConfig
MIDIDevicempDevice
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Detailed Description

Definition at line 32 of file MIDIOutControl.hxx.


Constructor & Destructor Documentation

CLAM::MIDIOutControl::MIDIOutControl ( )

Definition at line 28 of file MIDIOutControl.cxx.

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

CLAM::MIDIOutControl::MIDIOutControl ( const MIDIIOConfig c)

Definition at line 35 of file MIDIOutControl.cxx.

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


Member Function Documentation

bool CLAM::MIDIOutControl::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 associated with this MIDIOut object

Getting the MIDIManager object

Registering the MIDIOut object through the MIDIManager object

Reimplemented from CLAM::MIDIOut.

Definition at line 56 of file MIDIOutControl.cxx.

References CLAM::MIDIOut::ConcreteConfigure(), CLAM::MIDI::eNoteOn, CLAM::MIDI::eNoteOnOff, CLAM::MIDI::MessageInfo::field, CLAM::MIDI::GetMessageInfo(), and CLAM::MIDI::MessageInfo::length.

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

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

Reimplemented from CLAM::MIDIOut.

Definition at line 73 of file MIDIOutControl.hxx.


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