CLAM-Development
1.4.0
|
Using Segment as the type for * input and output ports. More...
#include <SMSTransformationChain.hxx>
Public Member Functions | |
void | AttachIn (Segment &data) |
void | AttachOut (Segment &data) |
SMSTransformationChain () | |
virtual | ~SMSTransformationChain () |
Destructor. | |
virtual bool | DoChildren () |
bool | Do () |
Supervised mode execution method (using ports) | |
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. | |
void | InitSegmentArray () |
void | InitAllFrameIndex () |
void | TurnOn (TIndex index) |
Accessor to On/off control. | |
void | TurnOff (TIndex index) |
Accessor to On/off control. | |
const ProcessingConfig & | GetConfig () const |
Configuration getter. | |
bool | ConcreteConfigure (const ProcessingConfig &c) |
Configuration method interface. | |
SegmentTransformation * | GetTransformation (const std::string &name) |
Returns first transformation in chain belonging to a given class or NULL if not found. | |
![]() | |
virtual | ~ProcessingComposite () |
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. |
Additional Inherited Members | |
![]() | |
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 |
![]() | |
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) |
Using Segment as the type for * input and output ports.
It implements the supervised Do and a helper method for updating the frame counter in the Segment.
Definition at line 44 of file SMSTransformationChain.hxx.
|
inline |
Definition at line 62 of file SMSTransformationChain.hxx.
References NULL.
|
inlinevirtual |
Destructor.
Deletes temporal ProcessingData and Configuration and any previously allocated Processing chainee.
Definition at line 71 of file SMSTransformationChain.hxx.
References CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), and CLAM::Array< T >::Size().
|
inline |
Definition at line 59 of file SMSTransformationChain.hxx.
|
inline |
Definition at line 60 of file SMSTransformationChain.hxx.
|
inlinevirtual |
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. |
First we remove existing chainee if any
Implements CLAM::ProcessingComposite.
Definition at line 194 of file SMSTransformationChain.hxx.
References CLAM_ASSERT, CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), CLAM::ProcessingComposite::composite_size(), CLAM::SMSTransformationChainConfig::ConfigList_begin(), CLAM::SMSTransformationChainConfig::ConfigList_end(), CLAM::ProcessingComposite::Remove(), and CLAM::ControlArray< ControlT >::Resize().
|
inlinevirtual |
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::ProcessingComposite.
Definition at line 119 of file SMSTransformationChain.hxx.
References CLAM::Array< T >::AddElem(), CLAM::SegmentTransformation::AttachIn(), CLAM::SegmentTransformation::AttachOut(), CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), InitAllFrameIndex(), and InitSegmentArray().
|
inlinevirtual |
Supervised mode execution method (using ports)
Implements CLAM::ProcessingComposite.
Definition at line 108 of file SMSTransformationChain.hxx.
References DoChildren().
|
inlinevirtual |
Definition at line 83 of file SMSTransformationChain.hxx.
References CLAM_DEBUG_ASSERT, CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), CLAM::ProcessingComposite::composite_size(), CLAM::SegmentTransformation::DoWithSegments(), and CLAM::Processing::IsRunning().
Referenced by Do().
|
inlinevirtual |
Configuration getter.
Gets the configuration parameters used to create the object.
Implements CLAM::ProcessingComposite.
Definition at line 189 of file SMSTransformationChain.hxx.
|
inline |
Returns first transformation in chain belonging to a given class or NULL if not found.
Definition at line 233 of file SMSTransformationChain.hxx.
References CLAM::ProcessingComposite::composite_begin(), CLAM::ProcessingComposite::composite_end(), and NULL.
|
inline |
Definition at line 170 of file SMSTransformationChain.hxx.
References CLAM::Segment::mCurrentFrameIndex, and CLAM::Array< T >::Size().
Referenced by ConcreteStart().
|
inline |
Definition at line 162 of file SMSTransformationChain.hxx.
References CLAM::Array< T >::SetSize(), and CLAM::Array< T >::Size().
Referenced by ConcreteStart().
|
inline |
Accessor to On/off control.
Turns on the specified control in the array.
Definition at line 184 of file SMSTransformationChain.hxx.
|
inline |
Accessor to On/off control.
Turns on the specified control in the array.
Definition at line 178 of file SMSTransformationChain.hxx.