Provides a descriptor of a job that allows to create new instances. More...
#include <Job.h>
Public Member Functions | |
| virtual std::string | className () const =0 |
| Returns the class name of the job. More... | |
| virtual std::string | category () const =0 |
| Returns a name of the category of job. More... | |
| virtual std::string | tooltip () const |
| Returns a help message, explaining what the job does and how it should be used. More... | |
| virtual AutoPtr< IJob > | create (Optional< std::string > instanceName) const =0 |
| Creates a new job instance. More... | |
 Public Member Functions inherited from Polymorphic | |
| virtual | ~Polymorphic () |
Detailed Description
Provides a descriptor of a job that allows to create new instances.
This is mainly intended to provide a way to enumerate all available jobs and create new instances of jobs without having a specific type at hand. Each class derived from IJob should be associated with one IJobDesc implementation. It is not necessary to implement this interface manually, consider using helper class JobRegistrar.
Member Function Documentation
◆ category()
|
pure virtual |
Returns a name of the category of job.
There is no predefined list of categories, it can be anything that describes the job, for example "simulations", "initial conditions", etc. For consistency, use plural nouns as in the examples.
◆ className()
|
pure virtual |
Returns the class name of the job.
It must be the same name as returned by IJob::className. It is necessary to duplicate the name here, as we need to get the class name without having to create a new instance of the job.
◆ create()
Creates a new job instance.
- Parameters
-
instanceName Name of the instance, may be NOTHING in which case a generic name will be assigned based on the class name.
◆ tooltip()
|
inlinevirtual |
The documentation for this class was generated from the following file:
- /home/pavel/projects/astro/sph/src/core/run/Job.h
