ODTask Class Reference

A class representing a modular task to be used with the On-Demand structures. More...

#include <ODTask.h>

Inheritance diagram for ODTask:

Collaboration diagram for ODTask:

Public Types
enum	{   eODNone = 0x00000000, eODFLAC = 0x00000001, eODMP3 = 0x00000002, eODFFMPEG = 0x00000004,   eODPCMSummary = 0x00001000, eODOTHER = 0x10000000 }

Public Member Functions
	ODTask ()
	Constructs an ODTask. More...
virtual	~ODTask ()
virtual std::unique_ptr< ODTask >	Clone () const =0
virtual unsigned int	GetODType ()
	Subclasses should override to return respective type. More...
void	DoSome (float amountWork=0.0)
void	DoAll ()
	Call DoSome until PercentComplete >= 1.0. More...
virtual float	PercentComplete ()
	return the amount of the task that has been completed. 0.0 to 1.0 More...
virtual bool	UsesCustomWorkUntilPercentage ()
virtual float	ComputeNextWorkUntilPercentageComplete ()
virtual bool	CanMergeWith (ODTask *otherTask)
virtual void	StopUsingWaveTrack (WaveTrack *track)
virtual void	ReplaceWaveTrack (Track *oldTrack, const std::shared_ptr< Track > &newTrack)
	Replaces all instances to a wavetrack with a NEW one, effectively transferring the task. More...
void	AddWaveTrack (const std::shared_ptr< WaveTrack > &track)
	Adds a WaveTrack to do the task for. More...
virtual int	GetNumWaveTracks ()
virtual std::shared_ptr< WaveTrack >	GetWaveTrack (int i)
virtual void	DemandTrackUpdate (WaveTrack *track, double seconds)
	changes the tasks associated with this Waveform to process the task from a different point in the track More...
bool	IsComplete ()
	return More...
void	TerminateAndBlock ()
virtual void	Terminate ()
	releases memory that the ODTask owns. Subclasses should override. More...
virtual const char *	GetTaskName ()
virtual sampleCount	GetDemandSample () const
virtual void	SetDemandSample (sampleCount sample)
virtual void	RecalculatePercentComplete ()
	does an od update and then recalculates the data. More...
int	GetTaskNumber ()
	returns the number of tasks created before this instance. More...
void	SetNeedsODUpdate ()
bool	GetNeedsODUpdate ()
void	ResetNeedsODUpdate ()
virtual TranslatableString	GetTip ()=0
virtual bool	IsTaskAssociatedWithProject (AudacityProject *proj)
	returns true if the task is associated with the project. More...
bool	IsRunning ()

Public Attributes
enum ODTask:: { ... }	ODTypeEnum

Protected Member Functions
virtual void	CalculatePercentComplete ()=0
	calculates the percentage complete from existing data. More...
virtual void	DoSomeInternal ()=0
virtual void	Update ()
	virtual method called before DoSomeInternal is used from DoSome. More...
virtual void	ODUpdate ()
void	SetIsRunning (bool value)

Protected Attributes
int	mTaskNumber
volatile float	mPercentComplete
ODLock	mPercentCompleteMutex
volatile bool	mDoingTask
volatile bool	mTaskStarted
volatile bool	mTerminate
ODLock	mTerminateMutex
ODLock	mBlockUntilTerminateMutex
std::vector< std::weak_ptr< WaveTrack > >	mWaveTracks
ODLock	mWaveTrackMutex
sampleCount	mDemandSample
ODLock	mDemandSampleMutex
volatile bool	mIsRunning
ODLock	mIsRunningMutex

Private Attributes
volatile bool	mNeedsODUpdate
ODLock	mNeedsODUpdateMutex

Detailed Description

A class representing a modular task to be used with the On-Demand structures.

ODTask is an abstract class that outlines the methods that will be used to support On-Demand background loading of files. These ODTasks are generally meant to be run in a background thread.

Definition at line 39 of file ODTask.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
eODNone
eODFLAC
eODMP3
eODFFMPEG
eODPCMSummary
eODOTHER

Definition at line 42 of file ODTask.h.

        {
      eODNone     =  0x00000000,
      eODFLAC     =  0x00000001,
      eODMP3      =  0x00000002,
      eODFFMPEG   =  0x00000004,
      eODPCMSummary  = 0x00001000,
      eODOTHER    =  0x10000000,
   } ODTypeEnum;

Constructor & Destructor Documentation

ODTask()

ODTask::ODTask

(

)

Constructs an ODTask.

Definition at line 35 of file ODTask.cpp.

: mDemandSample(0)
{
 
   static int sTaskNumber=0;
   mPercentComplete=0;
   mDoingTask=false;
   mTerminate = false;
   mNeedsODUpdate=false;
   mIsRunning = false;
 
   mTaskNumber=sTaskNumber++;
}

References mDoingTask, mIsRunning, mNeedsODUpdate, mPercentComplete, mTaskNumber, and mTerminate.

~ODTask()

virtual ODTask::~ODTask ( )

inlinevirtual

Definition at line 55 of file ODTask.h.

{};

Member Function Documentation

AddWaveTrack()

void ODTask::AddWaveTrack

(

const std::shared_ptr< WaveTrack > &

track

)

Adds a WaveTrack to do the task for.

Sets the wavetrack that will be analyzed for ODPCMAliasBlockFiles that will have their summaries computed and written to disk.

Definition at line 267 of file ODTask.cpp.

{
   mWaveTracks.push_back(track);
}

References mWaveTracks.

CalculatePercentComplete()

virtual void ODTask::CalculatePercentComplete ( )

protectedpure virtual

calculates the percentage complete from existing data.

Implemented in ODDecodeTask, and ODComputeSummaryTask.

Referenced by RecalculatePercentComplete().

Here is the caller graph for this function:

CanMergeWith()

virtual bool ODTask::CanMergeWith ( ODTask *  otherTask )

inlinevirtual

returns whether or not this task and another task can merge together, as when we make two mono tracks stereo. for Loading/Summarizing, this is not an issue because the entire track is processed Effects that affect portions of a track will need to check this.

Definition at line 81 of file ODTask.h.

{return strcmp(GetTaskName(),otherTask->GetTaskName())==0;}

References GetTaskName().

Here is the call graph for this function:

Clone()

virtual std::unique_ptr<ODTask> ODTask::Clone ( ) const

pure virtual

Implemented in ODDecodeFlacTask, and ODComputeSummaryTask.

ComputeNextWorkUntilPercentageComplete()

virtual float ODTask::ComputeNextWorkUntilPercentageComplete ( )

inlinevirtual

Reimplemented in ODComputeSummaryTask.

Definition at line 76 of file ODTask.h.

{return 1.0;}

Referenced by DoSome().

Here is the caller graph for this function:

DemandTrackUpdate()

void ODTask::DemandTrackUpdate ( WaveTrack *  track, double  seconds  )

virtual

changes the tasks associated with this Waveform to process the task from a different point in the track

changes the tasks associated with this Waveform to process the task from a different point in the track

Parameters

track	the track to update
seconds	the point in the track from which the tasks associated with track should begin processing from.

Reimplemented in ODDecodeTask.

Definition at line 318 of file ODTask.cpp.

{
   bool demandSampleChanged=false;
   mWaveTrackMutex.Lock();
   for(size_t i=0;i<mWaveTracks.size();i++)
   {
      if ( track == mWaveTracks[i].lock().get() )
      {
         auto newDemandSample = (sampleCount)(seconds * track->GetRate());
         demandSampleChanged = newDemandSample != GetDemandSample();
         SetDemandSample(newDemandSample);
         break;
      }
   }
   mWaveTrackMutex.Unlock();
 
   if(demandSampleChanged)
      SetNeedsODUpdate();
 
}

References GetDemandSample(), WaveTrack::GetRate(), mWaveTrackMutex, mWaveTracks, SetDemandSample(), and SetNeedsODUpdate().

Referenced by ODDecodeTask::DemandTrackUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

DoAll()

void ODTask::DoAll

(

)

Call DoSome until PercentComplete >= 1.0.

DoSome()

void ODTask::DoSome

(

float

amountWork = 0.0

)

Do a modular part of the task. For example, if the task is to load the entire file, load one BlockFile. Relies on DoSomeInternal(), which is the subclasses must implement.

Parameters

amountWork

the percent amount of the total job to do. 1.0 represents the entire job. the default of 0.0 will do the smallest unit of work possible

Do a modular part of the task. For example, if the task is to load the entire file, load one BlockFile. Relies on DoSomeInternal(), which the subclasses must implement.

Parameters

amountWork

the percent amount of the total job to do. 1.0 represents the entire job. the default of 0.0 will do the smallest unit of work possible

Definition at line 71 of file ODTask.cpp.

{
   SetIsRunning(true);
   mBlockUntilTerminateMutex.Lock();
 
//   wxPrintf("%s %i subtask starting on NEW thread with priority\n", GetTaskName(),GetTaskNumber());
 
   mDoingTask=mTaskStarted=true;
 
   float workUntil = amountWork+PercentComplete();
 
 
 
   //check periodically to see if we should exit.
   mTerminateMutex.Lock();
   if(mTerminate)
   {
      mTerminateMutex.Unlock();
      SetIsRunning(false);
      mBlockUntilTerminateMutex.Unlock();
      return;
   }
   mTerminateMutex.Unlock();
 
   Update();
 
 
   if(UsesCustomWorkUntilPercentage())
      workUntil = ComputeNextWorkUntilPercentageComplete();
 
   if(workUntil<PercentComplete())
      workUntil = PercentComplete();
 
   //Do Some of the task.
 
   mTerminateMutex.Lock();
   while(PercentComplete() < workUntil && PercentComplete() < 1.0 && !mTerminate)
   {
      wxThread::This()->Yield();
      //release within the loop so we can cut the number of iterations short
 
      DoSomeInternal(); //keep the terminate mutex on so we don't remo
      mTerminateMutex.Unlock();
      //check to see if ondemand has been called
      if(GetNeedsODUpdate() && PercentComplete() < 1.0)
         ODUpdate();
 
 
      //But add the mutex lock back before we check the value again.
      mTerminateMutex.Lock();
   }
   mTerminateMutex.Unlock();
   mDoingTask=false;
 
   mTerminateMutex.Lock();
   //if it is not done, put it back onto the ODManager queue.
   if(PercentComplete() < 1.0&& !mTerminate)
   {
      ODManager::Instance()->AddTask(this);
 
      //we did a bit of progress - we should allow a resave.
      ODLocker locker{ &AllProjects::Mutex() };
      for ( auto pProject : AllProjects{} )
      {
         if(IsTaskAssociatedWithProject(pProject.get()))
         {
            //mark the changes so that the project can be resaved.
            UndoManager::Get( *pProject ).SetODChangesFlag();
            break;
         }
      }
 
 
//      wxPrintf("%s %i is %f done\n", GetTaskName(),GetTaskNumber(),PercentComplete());
   }
   else
   {
      //for profiling, uncomment and look in audacity.app/exe's folder for AudacityProfile.txt
      //static int tempLog =0;
      //if(++tempLog % 5==0)
         //END_TASK_PROFILING("On Demand Drag and Drop 5 80 mb files into audacity, 5 wavs per task");
      //END_TASK_PROFILING("On Demand open an 80 mb wav stereo file");
 
      wxCommandEvent event( EVT_ODTASK_COMPLETE );
 
      ODLocker locker{ &AllProjects::Mutex() };
      for ( auto pProject : AllProjects{} )
      {
         if(IsTaskAssociatedWithProject(pProject.get()))
         {
            //this assumes tasks are only associated with one project.
            pProject->wxEvtHandler::AddPendingEvent(event);
            //mark the changes so that the project can be resaved.
            UndoManager::Get( *pProject ).SetODChangesFlag();
            break;
         }
      }
 
//      wxPrintf("%s %i complete\n", GetTaskName(),GetTaskNumber());
   }
   mTerminateMutex.Unlock();
   SetIsRunning(false);
   mBlockUntilTerminateMutex.Unlock();
}

References ODManager::AddTask(), ComputeNextWorkUntilPercentageComplete(), DoSomeInternal(), UndoManager::Get(), GetNeedsODUpdate(), ODManager::Instance, IsTaskAssociatedWithProject(), mBlockUntilTerminateMutex, mDoingTask, mTaskStarted, mTerminate, mTerminateMutex, AllProjects::Mutex(), ODUpdate(), PercentComplete(), SetIsRunning(), Update(), and UsesCustomWorkUntilPercentage().

Here is the call graph for this function:

DoSomeInternal()

virtual void ODTask::DoSomeInternal ( )

protectedpure virtual

pure virtual function that does some part of the task this object represents. this function is meant to be called repeatedly until IsComplete is true. Does the smallest unit of work for this task.

Implemented in ODDecodeTask, and ODComputeSummaryTask.

Referenced by DoSome().

Here is the caller graph for this function:

GetDemandSample()

sampleCount ODTask::GetDemandSample ( ) const

virtual

Definition at line 221 of file ODTask.cpp.

{
   sampleCount retval;
   mDemandSampleMutex.Lock();
   retval = mDemandSample;
   mDemandSampleMutex.Unlock();
   return retval;
}

References mDemandSample, and mDemandSampleMutex.

Referenced by ODComputeSummaryTask::Clone(), ODDecodeFlacTask::Clone(), DemandTrackUpdate(), ODDecodeTask::OrderBlockFiles(), and ODComputeSummaryTask::OrderBlockFiles().

Here is the caller graph for this function:

GetNeedsODUpdate()

bool ODTask::GetNeedsODUpdate

(

)

Definition at line 289 of file ODTask.cpp.

{
   bool ret;
   mNeedsODUpdateMutex.Lock();
   ret=mNeedsODUpdate;
   mNeedsODUpdateMutex.Unlock();
   return ret;
}

References mNeedsODUpdate, and mNeedsODUpdateMutex.

Referenced by DoSome(), and RecalculatePercentComplete().

Here is the caller graph for this function:

GetNumWaveTracks()

int ODTask::GetNumWaveTracks ( )

virtual

Definition at line 273 of file ODTask.cpp.

{
   int num;
   mWaveTrackMutex.Lock();
   num = (int)mWaveTracks.size();
   mWaveTrackMutex.Unlock();
   return num;
}

References mWaveTrackMutex, and mWaveTracks.

Referenced by ODWaveTrackTaskQueue::AddTask().

Here is the caller graph for this function:

GetODType()

virtual unsigned int ODTask::GetODType ( )

inlinevirtual

Subclasses should override to return respective type.

Reimplemented in ODDecodeTask, ODDecodeFlacTask, and ODComputeSummaryTask.

Definition at line 61 of file ODTask.h.

{return eODNone;}

References eODNone.

GetTaskName()

virtual const char* ODTask::GetTaskName ( )

inlinevirtual

Reimplemented in ODDecodeTask, and ODComputeSummaryTask.

Definition at line 104 of file ODTask.h.

{return "ODTask";}

Referenced by CanMergeWith().

Here is the caller graph for this function:

GetTaskNumber()

int ODTask::GetTaskNumber ( )

inline

returns the number of tasks created before this instance.

Definition at line 114 of file ODTask.h.

{return mTaskNumber;}

References mTaskNumber.

GetTip()

virtual TranslatableString ODTask::GetTip ( )

pure virtual

Implemented in ODDecodeTask, and ODComputeSummaryTask.

GetWaveTrack()

std::shared_ptr< WaveTrack > ODTask::GetWaveTrack ( int  i )

virtual

Definition at line 255 of file ODTask.cpp.

{
   std::shared_ptr< WaveTrack > track;
   mWaveTrackMutex.Lock();
   if(i<(int)mWaveTracks.size())
      track = mWaveTracks[i].lock();
   mWaveTrackMutex.Unlock();
   return track;
}

References mWaveTrackMutex, and mWaveTracks.

Referenced by ODManager::AddNewTask(), and ODWaveTrackTaskQueue::AddTask().

Here is the caller graph for this function:

IsComplete()

bool ODTask::IsComplete

(

)

return

Definition at line 249 of file ODTask.cpp.

{
   return PercentComplete() >= 1.0 && !IsRunning();
}

References IsRunning(), and PercentComplete().

Here is the call graph for this function:

IsRunning()

bool ODTask::IsRunning

(

)

Definition at line 212 of file ODTask.cpp.

{
   bool ret;
   mIsRunningMutex.Lock();
   ret= mIsRunning;
   mIsRunningMutex.Unlock();
   return ret;
}

References mIsRunning, and mIsRunningMutex.

Referenced by IsComplete().

Here is the caller graph for this function:

IsTaskAssociatedWithProject()

bool ODTask::IsTaskAssociatedWithProject ( AudacityProject *  proj )

virtual

returns true if the task is associated with the project.

Definition at line 176 of file ODTask.cpp.

{
   for (auto tr : TrackList::Get( *proj ).Any<const WaveTrack>())
   {
      //go over all tracks in the project
      //look inside our task's track list for one that matches this projects one.
      mWaveTrackMutex.Lock();
      for(int i=0;i<(int)mWaveTracks.size();i++)
      {
         if ( mWaveTracks[i].lock().get() == tr )
         {
            //if we find one, then the project is associated with us;return true
            mWaveTrackMutex.Unlock();
            return true;
         }
      }
      mWaveTrackMutex.Unlock();
   }
 
   return false;
 
}

References TrackList::Any(), TrackList::Get(), mWaveTrackMutex, and mWaveTracks.

Referenced by DoSome().

Here is the call graph for this function:

Here is the caller graph for this function:

ODUpdate()

void ODTask::ODUpdate ( )

protectedvirtual

virtual method called in DoSome everytime the user has demanded some OD function so that the ODTask can readjust its computation order. By default just calls Update(), but subclasses with special needs can override this

Definition at line 199 of file ODTask.cpp.

{
   Update();
   ResetNeedsODUpdate();
}

References ResetNeedsODUpdate(), and Update().

Referenced by DoSome(), and RecalculatePercentComplete().

Here is the call graph for this function:

Here is the caller graph for this function:

PercentComplete()

float ODTask::PercentComplete ( )

virtual

return the amount of the task that has been completed. 0.0 to 1.0

Definition at line 240 of file ODTask.cpp.

{
   mPercentCompleteMutex.Lock();
   float ret = mPercentComplete;
   mPercentCompleteMutex.Unlock();
   return ret;
}

References mPercentComplete, and mPercentCompleteMutex.

Referenced by DoSome(), and IsComplete().

Here is the caller graph for this function:

RecalculatePercentComplete()

void ODTask::RecalculatePercentComplete ( )

virtual

does an od update and then recalculates the data.

Definition at line 306 of file ODTask.cpp.

{
   if(GetNeedsODUpdate())
   {
      ODUpdate();
      CalculatePercentComplete();
   }
}

References CalculatePercentComplete(), GetNeedsODUpdate(), and ODUpdate().

Here is the call graph for this function:

ReplaceWaveTrack()

void ODTask::ReplaceWaveTrack ( Track *  oldTrack, const std::shared_ptr< Track > &  newTrack  )

virtual

Replaces all instances to a wavetrack with a NEW one, effectively transferring the task.

Replaces all instances to a wavetrack with a NEW one, effectively transferring the task. ODTask has no wavetrack, so it does nothing. But subclasses that do should override this.

Definition at line 352 of file ODTask.cpp.

{
   mWaveTrackMutex.Lock();
   for(size_t i=0;i<mWaveTracks.size();i++)
   {
      if(oldTrack == mWaveTracks[i].lock().get())
      {
         mWaveTracks[i] = std::static_pointer_cast<WaveTrack>( newTrack );
      }
   }
   mWaveTrackMutex.Unlock();
}

References mWaveTrackMutex, and mWaveTracks.

ResetNeedsODUpdate()

void ODTask::ResetNeedsODUpdate

(

)

Definition at line 298 of file ODTask.cpp.

{
   mNeedsODUpdateMutex.Lock();
   mNeedsODUpdate=false;
   mNeedsODUpdateMutex.Unlock();
}

References mNeedsODUpdate, and mNeedsODUpdateMutex.

Referenced by ODUpdate().

Here is the caller graph for this function:

SetDemandSample()

void ODTask::SetDemandSample ( sampleCount  sample )

virtual

Definition at line 230 of file ODTask.cpp.

{
 
   mDemandSampleMutex.Lock();
   mDemandSample=sample;
   mDemandSampleMutex.Unlock();
}

References mDemandSample, and mDemandSampleMutex.

Referenced by DemandTrackUpdate().

Here is the caller graph for this function:

SetIsRunning()

void ODTask::SetIsRunning ( bool  value )

protected

Definition at line 205 of file ODTask.cpp.

{
   mIsRunningMutex.Lock();
   mIsRunning=value;
   mIsRunningMutex.Unlock();
}

References mIsRunning, and mIsRunningMutex.

Referenced by DoSome().

Here is the caller graph for this function:

SetNeedsODUpdate()

void ODTask::SetNeedsODUpdate

(

)

Definition at line 283 of file ODTask.cpp.

{
   mNeedsODUpdateMutex.Lock();
   mNeedsODUpdate=true;
   mNeedsODUpdateMutex.Unlock();
}

References mNeedsODUpdate, and mNeedsODUpdateMutex.

Referenced by DemandTrackUpdate().

Here is the caller graph for this function:

StopUsingWaveTrack()

void ODTask::StopUsingWaveTrack ( WaveTrack *  track )

virtual

Definition at line 340 of file ODTask.cpp.

{
   mWaveTrackMutex.Lock();
   for(size_t i=0;i<mWaveTracks.size();i++)
   {
      if(mWaveTracks[i].lock().get() == track)
         mWaveTracks[i].reset();
   }
   mWaveTrackMutex.Unlock();
}

References mWaveTrackMutex, and mWaveTracks.

Terminate()

virtual void ODTask::Terminate ( )

inlinevirtual

releases memory that the ODTask owns. Subclasses should override.

Reimplemented in ODComputeSummaryTask.

Definition at line 102 of file ODTask.h.

{}

Referenced by TerminateAndBlock().

Here is the caller graph for this function:

TerminateAndBlock()

void ODTask::TerminateAndBlock

(

)

Definition at line 50 of file ODTask.cpp.

{
   //one mutex pair for the value of mTerminate
   mTerminateMutex.Lock();
   mTerminate=true;
   //release all data the derived class may have allocated
   mTerminateMutex.Unlock();
 
   //and one mutex pair for the exit of the function
   mBlockUntilTerminateMutex.Lock();
//TODO lock mTerminate?
   mBlockUntilTerminateMutex.Unlock();
 
   //wait till we are out of doSome() to terminate.
   Terminate();
}

References mBlockUntilTerminateMutex, mTerminate, mTerminateMutex, and Terminate().

Here is the call graph for this function:

Update()

virtual void ODTask::Update ( )

inlineprotectedvirtual

virtual method called before DoSomeInternal is used from DoSome.

Reimplemented in ODDecodeTask, and ODComputeSummaryTask.

Definition at line 139 of file ODTask.h.

{}

Referenced by DoSome(), and ODUpdate().

Here is the caller graph for this function:

UsesCustomWorkUntilPercentage()

virtual bool ODTask::UsesCustomWorkUntilPercentage ( )

inlinevirtual

Reimplemented in ODComputeSummaryTask.

Definition at line 75 of file ODTask.h.

{return false;}

Referenced by DoSome().

Here is the caller graph for this function:

Member Data Documentation

mBlockUntilTerminateMutex

ODLock ODTask::mBlockUntilTerminateMutex

protected

Definition at line 158 of file ODTask.h.

Referenced by DoSome(), and TerminateAndBlock().

mDemandSample

sampleCount ODTask::mDemandSample

protected

Definition at line 163 of file ODTask.h.

Referenced by GetDemandSample(), and SetDemandSample().

mDemandSampleMutex

ODLock ODTask::mDemandSampleMutex

mutableprotected

Definition at line 164 of file ODTask.h.

Referenced by GetDemandSample(), and SetDemandSample().

mDoingTask

volatile bool ODTask::mDoingTask

protected

Definition at line 153 of file ODTask.h.

Referenced by DoSome(), and ODTask().

mIsRunning

volatile bool ODTask::mIsRunning

protected

Definition at line 166 of file ODTask.h.

Referenced by IsRunning(), ODTask(), and SetIsRunning().

mIsRunningMutex

ODLock ODTask::mIsRunningMutex

protected

Definition at line 167 of file ODTask.h.

Referenced by IsRunning(), and SetIsRunning().

mNeedsODUpdate

volatile bool ODTask::mNeedsODUpdate

private

Definition at line 172 of file ODTask.h.

Referenced by GetNeedsODUpdate(), ODTask(), ResetNeedsODUpdate(), and SetNeedsODUpdate().

mNeedsODUpdateMutex

ODLock ODTask::mNeedsODUpdateMutex

private

Definition at line 173 of file ODTask.h.

Referenced by GetNeedsODUpdate(), ResetNeedsODUpdate(), and SetNeedsODUpdate().

mPercentComplete

volatile float ODTask::mPercentComplete

protected

Definition at line 151 of file ODTask.h.

Referenced by ODComputeSummaryTask::CalculatePercentComplete(), ODDecodeTask::CalculatePercentComplete(), ODComputeSummaryTask::ComputeNextWorkUntilPercentageComplete(), ODComputeSummaryTask::DoSomeInternal(), ODDecodeTask::DoSomeInternal(), ODTask(), and PercentComplete().

mPercentCompleteMutex

ODLock ODTask::mPercentCompleteMutex

protected

Definition at line 152 of file ODTask.h.

Referenced by ODComputeSummaryTask::CalculatePercentComplete(), ODDecodeTask::CalculatePercentComplete(), ODComputeSummaryTask::ComputeNextWorkUntilPercentageComplete(), ODComputeSummaryTask::DoSomeInternal(), ODDecodeTask::DoSomeInternal(), and PercentComplete().

mTaskNumber

int ODTask::mTaskNumber

protected

Definition at line 150 of file ODTask.h.

Referenced by GetTaskNumber(), and ODTask().

mTaskStarted

volatile bool ODTask::mTaskStarted

protected

Definition at line 154 of file ODTask.h.

Referenced by DoSome().

mTerminate

volatile bool ODTask::mTerminate

protected

Definition at line 155 of file ODTask.h.

Referenced by DoSome(), ODTask(), and TerminateAndBlock().

mTerminateMutex

ODLock ODTask::mTerminateMutex

protected

Definition at line 156 of file ODTask.h.

Referenced by DoSome(), and TerminateAndBlock().

mWaveTrackMutex

ODLock ODTask::mWaveTrackMutex

protected

Definition at line 161 of file ODTask.h.

Referenced by DemandTrackUpdate(), ODComputeSummaryTask::DoSomeInternal(), ODDecodeTask::DoSomeInternal(), GetNumWaveTracks(), GetWaveTrack(), IsTaskAssociatedWithProject(), ReplaceWaveTrack(), StopUsingWaveTrack(), ODComputeSummaryTask::Update(), and ODDecodeTask::Update().

mWaveTracks

std::vector< std::weak_ptr< WaveTrack > > ODTask::mWaveTracks

protected

Definition at line 160 of file ODTask.h.

Referenced by AddWaveTrack(), DemandTrackUpdate(), ODComputeSummaryTask::DoSomeInternal(), ODDecodeTask::DoSomeInternal(), GetNumWaveTracks(), GetWaveTrack(), IsTaskAssociatedWithProject(), ReplaceWaveTrack(), StopUsingWaveTrack(), ODComputeSummaryTask::Update(), and ODDecodeTask::Update().

ODTypeEnum

enum { ... } ODTask::ODTypeEnum

---

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

• ODTask.h
• ODTask.cpp