CLAM-Development  1.4.0
Public Member Functions
CLAM::SMSTransformationChain Class Reference

Using Segment as the type for * input and output ports. More...

#include <SMSTransformationChain.hxx>

List of all members.

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 ProcessingConfigGetConfig () const
 Configuration getter.
bool ConcreteConfigure (const ProcessingConfig &c)
 Configuration method interface.
SegmentTransformationGetTransformation (const std::string &name)
 Returns first transformation in chain belonging to a given class or NULL if not found.
- Public Member Functions inherited from CLAM::ProcessingComposite
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 ()
- 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.

Additional Inherited Members

- Public Types inherited from CLAM::ProcessingComposite
typedef std::list< Processing * >
::iterator 
iterator
 Processing object composite iterator.
- 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::ProcessingComposite
virtual bool ConcreteStop ()
 See ConcreteStart().
- Protected Member Functions inherited from CLAM::Processing
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)

Detailed Description

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.


Constructor & Destructor Documentation

CLAM::SMSTransformationChain::SMSTransformationChain ( )
inline

Definition at line 62 of file SMSTransformationChain.hxx.

References NULL.

virtual CLAM::SMSTransformationChain::~SMSTransformationChain ( )
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().


Member Function Documentation

void CLAM::SMSTransformationChain::AttachIn ( Segment data)
inline

Definition at line 59 of file SMSTransformationChain.hxx.

void CLAM::SMSTransformationChain::AttachOut ( Segment data)
inline

Definition at line 60 of file SMSTransformationChain.hxx.

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

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.

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

bool CLAM::SMSTransformationChain::ConcreteStart ( void  )
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().

bool CLAM::SMSTransformationChain::Do ( )
inlinevirtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 108 of file SMSTransformationChain.hxx.

References DoChildren().

virtual bool CLAM::SMSTransformationChain::DoChildren ( )
inlinevirtual
const ProcessingConfig& CLAM::SMSTransformationChain::GetConfig ( ) const
inlinevirtual

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.

Implements CLAM::ProcessingComposite.

Definition at line 189 of file SMSTransformationChain.hxx.

SegmentTransformation* CLAM::SMSTransformationChain::GetTransformation ( const std::string &  name)
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.

void CLAM::SMSTransformationChain::InitAllFrameIndex ( )
inline
void CLAM::SMSTransformationChain::InitSegmentArray ( )
inline

Definition at line 162 of file SMSTransformationChain.hxx.

References CLAM::Array< T >::SetSize(), and CLAM::Array< T >::Size().

Referenced by ConcreteStart().

void CLAM::SMSTransformationChain::TurnOff ( TIndex  index)
inline

Accessor to On/off control.

Turns on the specified control in the array.

Definition at line 184 of file SMSTransformationChain.hxx.

void CLAM::SMSTransformationChain::TurnOn ( TIndex  index)
inline

Accessor to On/off control.

Turns on the specified control in the array.

Definition at line 178 of file SMSTransformationChain.hxx.


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