CLAM-Development
1.4.0
|
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>
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 ProcessingConfig & | GetConfig () 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) |
![]() | |
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) |
InPortBase & | GetInPort (const std::string &name) |
OutPortBase & | GetOutPort (const std::string &name) |
InControlBase & | GetInControl (const std::string &name) |
OutControlBase & | GetOutControl (const std::string &name) |
InPortBase & | GetInPort (unsigned index) |
OutPortBase & | GetOutPort (unsigned index) |
InControlBase & | GetInControl (unsigned index) |
OutControlBase & | GetOutControl (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< TControlData > | OutValues |
Additional Inherited Members | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
![]() | |
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. | |
InControlRegistry & | GetInControls () |
Accessor to published Controls manager. | |
OutControlRegistry & | GetOutControls () |
Accessor to published Controls manager. | |
InPortRegistry & | GetInPorts () |
Accessor to published Ports manager. | |
OutPortRegistry & | GetOutPorts () |
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) |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
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.
CLAM::Controller::Controller | ( | ) |
Definition at line 40 of file Controller.cxx.
|
inline |
Definition at line 81 of file Controller.hxx.
References CLAM::Processing::Configure().
|
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.
Reference | to the configuration object. |
true if the processing object is left in a consistent state, and can be executed.
This | method 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().
|
inlinevirtual |
Supervised mode execution method (using ports)
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.
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Definition at line 86 of file Controller.hxx.
|
virtual |
Configuration getter.
Gets the configuration parameters used to create the object.
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.
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().