CLAM-Development  1.4.0
Public Member Functions | Protected Attributes
CLAM::ControlPiano Class Reference

#include <ControlPiano.hxx>

List of all members.

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
 ControlPiano (const Config &config=Config())
 ~ControlPiano ()
bool Do ()
 Supervised mode execution method (using ports)
void DoCallback (const MIDI::Message &inMessage)
void SendMIDIMessage (MIDI::Message &msg)
void SetNoteStatus (TSize i, bool state)
bool GetNoteStatus (TSize i)
TSize GetVelocity ()
TSize GetOctave ()
- 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.
virtual const ProcessingConfigGetConfig () const
 Configuration getter.
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 Attributes

InControl< MIDI::MessagemInputMIDIMessage
 Controls.
OutControl< MIDI::MessagemOutputMIDIMessage
std::vector< bool > _notes
 Enabled/Disabled. Size: 12. One octave, from A to G#.
TSize _velocity
TSize _octave
- Protected Attributes inherited from CLAM::Processing
ProcessingCompositempParent
 Pointer to the parent (composite) processing object, or 0.
Network_network
 The parent network if any.

Additional Inherited Members

- Public Types inherited from CLAM::Processing
enum  ExecState { Unconfigured = 0, Ready, Running }
 Processing Object possible execution states. More...
typedef NullProcessingConfig Config
- Protected Member Functions inherited from CLAM::Processing
virtual bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method interface.
virtual bool ConcreteStart ()
 Processing objects have to redefine this method when starting them implies some internal changes.
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)

Detailed Description

Definition at line 32 of file ControlPiano.hxx.


Constructor & Destructor Documentation

CLAM::ControlPiano::ControlPiano ( const Config config = Config())
inline

Definition at line 44 of file ControlPiano.hxx.

References _notes, _octave, _velocity, and CLAM::Processing::Configure().

CLAM::ControlPiano::~ControlPiano ( )
inline

Definition at line 58 of file ControlPiano.hxx.


Member Function Documentation

bool CLAM::ControlPiano::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 62 of file ControlPiano.hxx.

void CLAM::ControlPiano::DoCallback ( const MIDI::Message inMessage)
inline
const char* CLAM::ControlPiano::GetClassName ( ) const
inlinevirtual

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

Implements CLAM::Processing.

Definition at line 35 of file ControlPiano.hxx.

bool CLAM::ControlPiano::GetNoteStatus ( TSize  i)
inline

Definition at line 96 of file ControlPiano.hxx.

References _notes.

TSize CLAM::ControlPiano::GetOctave ( )
inline

Definition at line 106 of file ControlPiano.hxx.

References _octave.

TSize CLAM::ControlPiano::GetVelocity ( )
inline

Definition at line 101 of file ControlPiano.hxx.

References _velocity.

void CLAM::ControlPiano::SendMIDIMessage ( MIDI::Message msg)
inline
void CLAM::ControlPiano::SetNoteStatus ( TSize  i,
bool  state 
)
inline

Definition at line 91 of file ControlPiano.hxx.

References _notes.


Member Data Documentation

std::vector<bool> CLAM::ControlPiano::_notes
protected

Enabled/Disabled. Size: 12. One octave, from A to G#.

Definition at line 112 of file ControlPiano.hxx.

Referenced by ControlPiano(), DoCallback(), GetNoteStatus(), and SetNoteStatus().

TSize CLAM::ControlPiano::_octave
protected

Definition at line 114 of file ControlPiano.hxx.

Referenced by ControlPiano(), and GetOctave().

TSize CLAM::ControlPiano::_velocity
protected

Definition at line 113 of file ControlPiano.hxx.

Referenced by ControlPiano(), and GetVelocity().

InControl< MIDI::Message > CLAM::ControlPiano::mInputMIDIMessage
protected

Controls.

Definition at line 39 of file ControlPiano.hxx.

OutControl< MIDI::Message > CLAM::ControlPiano::mOutputMIDIMessage
protected

Definition at line 40 of file ControlPiano.hxx.

Referenced by DoCallback(), and SendMIDIMessage().


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