MyraMath
Public Member Functions | List of all members
myra::Job Class Reference

Abstraction to represent one node of a JobGraph. More...

#include <Job.h>

Inheritance diagram for myra::Job:
[legend]

Public Member Functions

 Job ()
 Default constructor.
 
virtual JobID id () const
 Returns the JobID of this Job.
 
virtual void parents (JobIDs &output) const
 Returns the JobIDs of parents - predecessor Jobs that must execute() before this one.
 
virtual void children (JobIDs &output) const
 Returns the JobIDs of children - successor Jobs that can only execute() after this one.
 
bool notify (const JobID &j)
 Notifies this Job that one of it's parents has execute()'d.
 
virtual uint64_t execute ()
 Subtypes inject the "real work" here. Should return the amount of "work" performed.
 
virtual std::string name () const
 Returns a printable name for this Job, for debugging.
 
virtual ~Job ()
 Virtual destructor, for subtypes to release resources.
 

Detailed Description

Abstraction to represent one node of a JobGraph.


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