MezzanineEngine 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
Mezzanine::Audio::iEffectFilterCleanWorkUnit Class Referenceabstract

This is the work unit for marking all effects and filters as clean after sounds have been processed. More...

#include <audiomanager.h>

+ Inheritance diagram for Mezzanine::Audio::iEffectFilterCleanWorkUnit:
+ Collaboration diagram for Mezzanine::Audio::iEffectFilterCleanWorkUnit:

Public Member Functions

virtual ~iEffectFilterCleanWorkUnit ()
 Class destructor.
 
virtual void DoWork (Threading::DefaultThreadSpecificStorage::Type &CurrentThreadStorage)=0
 This does the required cleaning of all effects and filters in use by this manager. More...
 
- Public Member Functions inherited from Mezzanine::Threading::DefaultWorkUnit
 DefaultWorkUnit ()
 Simple constructor.
 
virtual ~DefaultWorkUnit ()
 Virtual destructor, doesn't actually do much.
 
virtual void AddDependency (iWorkUnit *NewDependency)
 Force this WorkUnit to Start after another has completed. More...
 
virtual void ClearDependencies ()
 Drop any information about what work units this one depends on.
 
virtual iWorkUnitGetDependency (Whole Index) const
 This is used to iterate of all the dependencies. More...
 
virtual Whole GetDependencyCount () const
 How many other WorkUnits does this one depend on? More...
 
virtual Whole GetDependentCount (FrameScheduler &SchedulerToCount)
 This returns the count workunits that depend on this work unit. More...
 
virtual Whole GetImmediateDependencyCount () const
 Get the amount of dependencies that directly count on this for access purposes. More...
 
virtual Whole GetPerformance () const
 Get the internal rolling average for querying. More...
 
virtual RollingAverage< Whole > & GetPerformanceLog ()
 Get the internal rolling average for querying. More...
 
virtual RunningState GetRunningState () const
 Retrieves the current RunningState of the thread. More...
 
virtual WorkUnitKey GetSortingKey (FrameScheduler &SchedulerToCount)
 Get the sorting metadata. More...
 
virtual bool IsEveryDependencyComplete ()
 Check if this WorkUnit could concievably run right now. More...
 
virtual void operator() (DefaultThreadSpecificStorage::Type &CurrentThreadStorage)
 This does everything required to track metadata and log work. More...
 
virtual void PrepareForNextFrame ()
 This resets the running state and takes any further action required to use the WorkUnit again.
 
virtual void RemoveDependency (iWorkUnit *RemoveDependency)
 Remove a dependency. More...
 
virtual RunningState TakeOwnerShip ()
 Attempts to atomically start the work unit in the current thread. More...
 
- Public Member Functions inherited from Mezzanine::Threading::iWorkUnit
virtual ~iWorkUnit ()
 Virtual destructor.
 

Additional Inherited Members

- Protected Attributes inherited from Mezzanine::Threading::DefaultWorkUnit
Int32 CurrentRunningState
 This controls do work with this after it has.
 
std::vector< iWorkUnit * > Dependencies
 A collection of of workunits that must be complete before this one can start.
 
DefaultRollingAverage< Whole >
::Type 
PerformanceLog
 A rolling average of execution times.
 

Detailed Description

This is the work unit for marking all effects and filters as clean after sounds have been processed.

Definition at line 90 of file audiomanager.h.

Member Function Documentation

virtual void Mezzanine::Audio::iEffectFilterCleanWorkUnit::DoWork ( Threading::DefaultThreadSpecificStorage::Type CurrentThreadStorage)
pure virtual

This does the required cleaning of all effects and filters in use by this manager.

Parameters
CurrentThreadStorageThe storage class for all resources owned by this work unit during it's execution.

Implements Mezzanine::Threading::iWorkUnit.


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