Abstract class for processing object agregates. More...
#include <ProcessingComposite.hxx>
Public Types | |
| typedef std::list< Processing * > ::iterator | iterator |
| Processing object composite iterator. | |
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 () |
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(). | |
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.
| virtual CLAM::ProcessingComposite::~ProcessingComposite | ( | ) | [inline, virtual] |
Definition at line 59 of file ProcessingComposite.hxx.
| iterator CLAM::ProcessingComposite::composite_begin | ( | ) | [inline] |
Definition at line 76 of file ProcessingComposite.hxx.
Referenced by ConcreteStart(), ConcreteStop(), and Remove().
| iterator CLAM::ProcessingComposite::composite_end | ( | ) | [inline] |
Definition at line 78 of file ProcessingComposite.hxx.
Referenced by ConcreteStart(), ConcreteStop(), and Remove().
| std::size_t CLAM::ProcessingComposite::composite_size | ( | ) | [inline] |
Definition at line 80 of file ProcessingComposite.hxx.
| virtual bool CLAM::ProcessingComposite::ConcreteConfigure | ( | const ProcessingConfig & | ) | [protected, pure 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::TopLevelProcessing, and CLAM::SMSTransformationChain.
| bool CLAM::ProcessingComposite::ConcreteStart | ( | void | ) | [protected, virtual] |
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::SMSAnalysis, CLAM::SMSAnalysisCore, and CLAM::SMSTransformationChain.
Definition at line 27 of file ProcessingComposite.cxx.
References composite_begin(), and composite_end().
| bool CLAM::ProcessingComposite::ConcreteStop | ( | ) | [protected, virtual] |
See ConcreteStart().
Reimplemented from CLAM::Processing.
Definition at line 53 of file ProcessingComposite.cxx.
References composite_begin(), and composite_end().
| virtual bool CLAM::ProcessingComposite::Do | ( | void | ) | [pure virtual] |
Supervised mode execution method (using ports).
Implements CLAM::Processing.
Implemented in CLAM::AudioWindowing, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::FrameAdder, CLAM::FrameInterpolator, CLAM::TopLevelProcessing, CLAM::Instrument, CLAM::SinusoidalSynthesis, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, and CLAM::SMSTransformationChain.
| virtual const char* CLAM::ProcessingComposite::GetClassName | ( | ) | const [inline, virtual] |
Override it in every subclass and retur the name of that class.
Implements CLAM::Processing.
Reimplemented in CLAM::AudioWindowing, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::TopLevelProcessing, CLAM::Instrument, CLAM::SinusoidalSynthesis, CLAM::SMSSynthesis, and CLAM::SpectralSynthesis.
Definition at line 65 of file ProcessingComposite.hxx.
| virtual const ProcessingConfig& CLAM::ProcessingComposite::GetConfig | ( | ) | const [pure virtual] |
Configuration getter.
Gets the configuration parameters used to create the object.
Reimplemented from CLAM::Processing.
Implemented in CLAM::AudioWindowing, CLAM::SMSAnalysis, CLAM::SMSAnalysisCore, CLAM::SpectralAnalysis, CLAM::FrameAdder, CLAM::FrameInterpolator, CLAM::TopLevelProcessing, CLAM::SinusoidalSynthesis, CLAM::SMSSynthesis, CLAM::SpectralSynthesis, and CLAM::SMSTransformationChain.
| void CLAM::ProcessingComposite::Insert | ( | Processing & | o | ) | throw (ErrProcessingObj) |
Definition at line 72 of file ProcessingComposite.cxx.
| void CLAM::ProcessingComposite::Remove | ( | Processing & | o | ) |
Definition at line 61 of file ProcessingComposite.cxx.
References composite_begin(), and composite_end().
1.6.3