CLAM-Development  1.4.0
Public Member Functions | Static Public Member Functions | Protected Member Functions
CLAM::TopLevelProcessing Class Reference

Top level processing object composite. More...

#include <TopLevelProcessing.hxx>

List of all members.

Public Member Functions

const char * GetClassName () const
 Override it in every subclass and retur the name of that class.
const ProcessingConfigGetConfig () const
 Configuration getter.
bool Do (void)
 Supervised mode execution method (using ports)
- Public Member Functions inherited from CLAM::ProcessingComposite
virtual ~ProcessingComposite ()
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.

Static Public Member Functions

static TopLevelProcessingGetInstance ()
 Singleton accessor.

Protected Member Functions

bool ConcreteConfigure (const ProcessingConfig &)
 Configuration method interface.
- Protected Member Functions inherited from CLAM::ProcessingComposite
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().
- 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)

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

Detailed Description

Top level processing object composite.

This is a singleton class used to agregate all the horphan processing objects. It will allways be the upper composite object in the processing object hierarchy.

Definition at line 45 of file TopLevelProcessing.hxx.


Member Function Documentation

bool CLAM::TopLevelProcessing::ConcreteConfigure ( const ProcessingConfig )
protectedvirtual

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.

Implements CLAM::ProcessingComposite.

Definition at line 34 of file TopLevelProcessing.cxx.

References CLAM_ASSERT.

bool CLAM::TopLevelProcessing::Do ( void  )
virtual

Supervised mode execution method (using ports)

Returns:
A boolean telling whether it has been output

Implements CLAM::ProcessingComposite.

Definition at line 47 of file TopLevelProcessing.cxx.

References CLAM_ASSERT.

const char* CLAM::TopLevelProcessing::GetClassName ( ) const
inlinevirtual

Override it in every subclass and retur the name of that class.

Reimplemented from CLAM::ProcessingComposite.

Definition at line 55 of file TopLevelProcessing.hxx.

const ProcessingConfig& CLAM::TopLevelProcessing::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 60 of file TopLevelProcessing.hxx.

TopLevelProcessing & CLAM::TopLevelProcessing::GetInstance ( )
static

Singleton accessor.

Definition at line 40 of file TopLevelProcessing.cxx.

Referenced by CLAM::Processing::SetParent().


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