AGX Dynamics 2.42.3.1
Loading...
Searching...
No Matches
agx::JobGroup Class Reference

A group of jobs to be executed. More...

#include <Job.h>

+ Inheritance diagram for agx::JobGroup:

Public Member Functions

 JobGroup ()
 
virtual ~JobGroup ()
 
void addJob (Job *job)
 
const JobPtrVector & getSubJobs () const
 
void init ()
 
- Public Member Functions inherited from agx::Job
 Job ()
 
 Job (const Callback &callback, agx::UInt32 costEstimate=100)
 
 Job (const Job &other)
 
virtual ~Job ()
 
void addDependency (Job *parent)
 Add a dependency to a job.
 
void clearChildDependencies ()
 Remove all child dependencies.
 
void decrementNumDependencies (agx::UInt32 size=1)
 Explicitly decrement the number of parent dependencies.
 
Thread * getAssignedThread ()
 
const Callback & getCallback () const
 Return the current callback.
 
const JobPtrVector & getChildDependencies () const
 
agx::UInt32 getCostEstimate () const
 
Real getExecutionTime () const
 
const char * getName () const
 
agx::UInt32 getNumDependencies () const
 
const JobPtrVector & getParentDependencies () const
 
SyncTag * getSyncTag ()
 
agx::UInt32 getTag () const
 
Thread * getTargetThread ()
 
Task * getTask ()
 
const Timer & getTimer () const
 
bool hasDependency (Job *parent)
 
virtual void implementation ()
 Job implementation, override in subclass.
 
void incrementNumDependencies (agx::UInt32 size=1)
 Explicitly increment the number of parent dependencies.
 
agx::Index & index ()
 
const agx::Index & index () const
 
void init (const Callback &callback=Callback(), agx::UInt32 costEstimate=100)
 Initialize the job.
 
Job & operator= (const Job &other)
 
void removeAllDependencies ()
 Remove all parent dependencies.
 
void removeDependency (Job *parent)
 Remove a dependency from a job.
 
bool resolve ()
 Increase the dependency counter for the job, and queue job for execution if all dependencies are resolved.
 
void setCallback (const Callback &callback)
 Set the callback which is called when execute() runs.
 
void setCostEstimate (agx::UInt32 cost)
 Specify the cost estimate for this job.
 
void setName (const char *name)
 Set the name of the job, for debugging.
 
void setNumDependencies (agx::UInt32 numDependencies)
 Explicitly set the number of parent dependencies.
 
void setSyncTag (SyncTag *tag)
 Set the synchronization tag which must enter completion status before the job is executed.
 
void setTag (agx::UInt32 tag)
 Set the job tag, can be used to keep track of different job classes etc.
 
void setTargetThread (Thread *thread)
 Set the target thread which the job will be executed on.
 
void setTask (Task *task)
 Set the task which the job belongs to.
 
void spawn ()
 Schedule job for execution in thread pool.
 
- Public Member Functions inherited from agx::Callback
 Callback ()
 
 Callback (const CallbackFunction &func, bool repeatEnable=true)
 
template<class ClassT >
 Callback (void(ClassT::*fun)(), ClassT *obj, bool repeatEnable=true)
 
const CallbackFunction & implementation () const
 Return the std representation.
 
bool isRepeating () const
 
bool isValid () const
 
 operator bool () const
 
 operator const CallbackFunction & () const
 
void operator() () const
 Execute the callback.
 
void run () const
 

Protected Member Functions

virtual void implementation () override
 Job implementation, override in subclass.
 

Additional Inherited Members

- Public Types inherited from agx::Callback
typedef std::function< void()> CallbackFunction
 
- Protected Attributes inherited from agx::Job
Thread * m_assignedThread
 
Callback m_callback
 
JobPtrVector m_children
 
agx::UInt32 m_cost
 
std::atomic< Int32 > m_dependencyCounter
 
agx::Index m_index
 
const char * m_name
 
agx::UInt32 m_numDependencies
 
JobPtrVector m_parents
 
SyncTagRef m_syncTag
 
agx::UInt32 m_tag
 
Thread * m_targetThread
 
Task * m_task
 
Timer m_timer
 

Detailed Description

A group of jobs to be executed.

Less overhead than having a sequence of jobs with serial dependencies.

Definition at line 338 of file Job.h.

Constructor & Destructor Documentation

◆ JobGroup()

agx::JobGroup::JobGroup ( )

Definition at line 584 of file Job.h.

◆ ~JobGroup()

virtual agx::JobGroup::~JobGroup ( )
virtual

References agx::init().

Member Function Documentation

◆ addJob()

void agx::JobGroup::addJob ( Job *  job)

◆ getSubJobs()

const JobPtrVector & agx::JobGroup::getSubJobs ( ) const

Definition at line 602 of file Job.h.

◆ implementation()

virtual void agx::JobGroup::implementation ( )
overrideprotectedvirtual

Job implementation, override in subclass.

Default implementation use a generic callback.

Reimplemented from agx::Job.

◆ init()

void agx::JobGroup::init ( )

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