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

This processing object is mainly an aggregate of out controls, that can be connected with other POs in controls, as usual. More...

#include <Controller.hxx>

List of all members.

Public Member Functions

 Controller ()
 Controller (const ControllerConfig &c)
const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
bool Do ()
 Supervised mode execution method (using ports)
const ProcessingConfigGetConfig () const
 Configuration getter.
virtual bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method interface.
void EnqueueControl (unsigned id, TControlData data)
 Interface for the users of the class.
TControlData LastDequeuedValue (unsigned id)
- 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.

Public Attributes

OutControlArray OutControls
std::vector< TControlDataOutValues

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

This processing object is mainly an aggregate of out controls, that can be connected with other POs in controls, as usual.

This objecte can be wrapped by a Midi Object or View and generate ControlSend messages. It works by asynchronously receiving messages, keeping them enqueued and synchronously dispatching them, at Do() time.

Note that if mulithreading is enabled, the EnqueueControl calls can be done from different threads than the execution method. A lock for the mDataQueue structure ensures it.

Definition at line 77 of file Controller.hxx.


Constructor & Destructor Documentation

CLAM::Controller::Controller ( )

Definition at line 40 of file Controller.cxx.

CLAM::Controller::Controller ( const ControllerConfig c)
inline

Definition at line 81 of file Controller.hxx.

References CLAM::Processing::Configure().


Member Function Documentation

bool CLAM::Controller::ConcreteConfigure ( const ProcessingConfig )
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.

Parameters:
Referenceto the configuration object.
Returns:
false if the object is not yet fully configured. (For example, if some important configuration attribute such as number of ports was set to zero in the config object)

true if the processing object is left in a consistent state, and can be executed.

Exceptions:
Thismethod must throw a bad_cast exception if the argument is not an object of the expected configuration class.

Reimplemented from CLAM::Processing.

Definition at line 46 of file Controller.cxx.

References CLAM_ASSERT, CLAM::Processing::CopyAsConcreteConfig(), OutControls, OutValues, CLAM::ControlArray< ControlT >::Resize(), and CLAM::ControlArray< ControlT >::Size().

bool CLAM::Controller::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::Processing.

Definition at line 88 of file Controller.hxx.

References OutControls, and OutValues.

void CLAM::Controller::EnqueueControl ( unsigned  id,
TControlData  data 
)

Interface for the users of the class.

As: a sliders view class, a midi class...

Definition at line 92 of file Controller.cxx.

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

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

Implements CLAM::Processing.

Definition at line 86 of file Controller.hxx.

const ProcessingConfig & CLAM::Controller::GetConfig ( ) const
virtual

Configuration getter.

Gets the configuration parameters used to create the object.

Returns:
Const reference to the configuration object. The usual way to perform a configuration change in the processing object is to take a copy of this reference, to change it and to send it with the Configure method. If not overriden, it returns a NullProcessingConfig.

Reimplemented from CLAM::Processing.

Definition at line 86 of file Controller.cxx.

TControlData CLAM::Controller::LastDequeuedValue ( unsigned  id)

Definition at line 104 of file Controller.cxx.

References OutValues.


Member Data Documentation

OutControlArray CLAM::Controller::OutControls

Definition at line 119 of file Controller.hxx.

Referenced by ConcreteConfigure(), and Do().

std::vector<TControlData> CLAM::Controller::OutValues

Definition at line 120 of file Controller.hxx.

Referenced by ConcreteConfigure(), Do(), and LastDequeuedValue().


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