CLAM-Development
1.4.0
|
Abstract class for processing object agregates. More...
#include <ProcessingComposite.hxx>
Public Types | |
typedef std::list< Processing * > ::iterator | iterator |
Processing object composite iterator. | |
![]() | |
enum | ExecState { Unconfigured = 0, Ready, Running } |
Processing Object possible execution states. More... | |
typedef NullProcessingConfig | Config |
Public Member Functions | |
virtual | ~ProcessingComposite () |
virtual bool | Do (void)=0 |
Supervised mode execution method (using ports) | |
virtual const ProcessingConfig & | GetConfig () const =0 |
Configuration getter. | |
virtual const char * | GetClassName () const |
Override it in every subclass and retur the name of that class. | |
void | Insert (Processing &o) throw (ErrProcessingObj) |
void | Remove (Processing &o) |
iterator | composite_begin () |
iterator | composite_end () |
std::size_t | composite_size () |
![]() | |
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. |
Protected Member Functions | |
virtual bool | ConcreteConfigure (const ProcessingConfig &)=0 |
Configuration method interface. | |
virtual bool | ConcreteStart () |
Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class. | |
virtual bool | ConcreteStop () |
See ConcreteStart(). | |
![]() | |
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) |
Additional Inherited Members | |
![]() | |
ProcessingComposite * | mpParent |
Pointer to the parent (composite) processing object, or 0. | |
Network * | _network |
The parent network if any. |
Abstract class for processing object agregates.
Definition at line 33 of file ProcessingComposite.hxx.
typedef std::list<Processing*>::iterator CLAM::ProcessingComposite::iterator |
Processing object composite iterator.
Definition at line 74 of file ProcessingComposite.hxx.
|
inlinevirtual |
Definition at line 59 of file ProcessingComposite.hxx.
|
inline |
Definition at line 76 of file ProcessingComposite.hxx.
Referenced by CLAM::SMSTransformationChain::ConcreteConfigure(), ConcreteStart(), CLAM::SMSTransformationChain::ConcreteStart(), ConcreteStop(), CLAM::SMSTransformationChain::DoChildren(), CLAM::SMSTransformationChain::GetTransformation(), Remove(), and CLAM::SMSTransformationChain::~SMSTransformationChain().
|
inline |
Definition at line 78 of file ProcessingComposite.hxx.
Referenced by CLAM::SMSTransformationChain::ConcreteConfigure(), ConcreteStart(), CLAM::SMSTransformationChain::ConcreteStart(), ConcreteStop(), CLAM::SMSTransformationChain::DoChildren(), CLAM::SMSTransformationChain::GetTransformation(), Remove(), and CLAM::SMSTransformationChain::~SMSTransformationChain().
|
inline |
Definition at line 80 of file ProcessingComposite.hxx.
Referenced by CLAM::SMSTransformationChain::ConcreteConfigure(), and CLAM::SMSTransformationChain::DoChildren().
|
protectedpure 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.
Implemented in CLAM::SMSTransformationChain, and CLAM::TopLevelProcessing.
|
protectedvirtual |
Concrete start implementation, called when the user calls Start() on the Processing(Composite), should be used to implement any specific start implementation required by classes deriving from this class.
When overriding this function in a class derived from ProcessingComposite be sure to call the base class (so child Processings are properly started).
Reimplemented from CLAM::Processing.
Reimplemented in CLAM::SMSTransformationChain, CLAM::SMSAnalysisCore, and CLAM::SMSAnalysis.
Definition at line 27 of file ProcessingComposite.cxx.
References composite_begin(), and composite_end().
|
protectedvirtual |
See ConcreteStart().
Reimplemented from CLAM::Processing.
Definition at line 53 of file ProcessingComposite.cxx.
References composite_begin(), and composite_end().
|
pure virtual |
Supervised mode execution method (using ports)
Implements CLAM::Processing.
Implemented in CLAM::SpectralSynthesis, CLAM::SMSSynthesis, CLAM::SinusoidalSynthesis, CLAM::SMSTransformationChain, CLAM::Instrument, CLAM::FrameInterpolator, CLAM::FrameAdder, CLAM::SpectralAnalysis, CLAM::SMSAnalysisCore, CLAM::TopLevelProcessing, CLAM::AudioWindowing, and CLAM::SMSAnalysis.
|
inlinevirtual |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Reimplemented in CLAM::SpectralSynthesis, CLAM::Instrument, CLAM::SMSSynthesis, CLAM::SinusoidalSynthesis, CLAM::SpectralAnalysis, CLAM::SMSAnalysisCore, CLAM::TopLevelProcessing, CLAM::AudioWindowing, and CLAM::SMSAnalysis.
Definition at line 65 of file ProcessingComposite.hxx.
|
pure virtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Implemented in CLAM::SMSTransformationChain, CLAM::SpectralSynthesis, CLAM::SMSSynthesis, CLAM::SinusoidalSynthesis, CLAM::FrameInterpolator, CLAM::FrameAdder, CLAM::SpectralAnalysis, CLAM::SMSAnalysisCore, CLAM::TopLevelProcessing, CLAM::AudioWindowing, and CLAM::SMSAnalysis.
void CLAM::ProcessingComposite::Insert | ( | Processing & | o | ) | throw (ErrProcessingObj) |
Definition at line 72 of file ProcessingComposite.cxx.
Referenced by CLAM::Processing::SetParent().
void CLAM::ProcessingComposite::Remove | ( | Processing & | o | ) |
Definition at line 61 of file ProcessingComposite.cxx.
References composite_begin(), and composite_end().
Referenced by CLAM::SMSTransformationChain::ConcreteConfigure(), CLAM::Processing::SetParent(), and CLAM::Processing::~Processing().