#include <GeometryJobs.h>
Public Member Functions | |
| BooleanGeometryJob (const std::string &name) | |
| virtual std::string | className () const override |
| Name representing the type of the job (e.e. "SPH"). More... | |
| virtual UnorderedMap< std::string, ExtJobType > | getSlots () const override |
| Lists all potential inputs of the job. More... | |
| virtual VirtualSettings | getSettings () override |
| Returns a settings object which allows to query and modify the state of the job. More... | |
| virtual void | evaluate (const RunSettings &global, IRunCallbacks &callbacks) override |
| Runs the operation provided by the job. More... | |
 Public Member Functions inherited from IGeometryJob | |
| IGeometryJob (const std::string &name) | |
| virtual Optional< ExtJobType > | provides () const override final |
| Specifies the type of the job, i.e. what kind of data the job provides. More... | |
| virtual JobContext | getResult () const override final |
| Returns the result of the job. More... | |
| Public Member Functions inherited from IJob | |
| IJob (const std::string &name) | |
| virtual std::string | instanceName () const |
| Unique name representing this job. More... | |
| virtual UnorderedMap< std::string, ExtJobType > | requires () const |
| List of slots that need to be connected to evaluate the job. More... | |
| Public Member Functions inherited from Polymorphic | |
| virtual | ~Polymorphic () |
Additional Inherited Members | |
| Protected Member Functions inherited from IJob | |
| template<typename T > | |
| SharedPtr< T > | getInput (const std::string &name) const |
| Convenient function to return input data for slot of given name. More... | |
| Protected Attributes inherited from IGeometryJob | |
| SharedPtr< IDomain > | result |
| Data filled by the job when it finishes. More... | |
| Protected Attributes inherited from IJob | |
| std::string | instName |
| UnorderedMap< std::string, JobContext > | inputs |
| Contains all input data, identified by names of input slots. More... | |
Detailed Description
Definition at line 259 of file GeometryJobs.h.
Constructor & Destructor Documentation
◆ BooleanGeometryJob()
|
inline |
Definition at line 264 of file GeometryJobs.h.
Member Function Documentation
◆ className()
|
inlineoverridevirtual |
Name representing the type of the job (e.e. "SPH").
Implements IJob.
Definition at line 269 of file GeometryJobs.h.
◆ evaluate()
|
overridevirtual |
Runs the operation provided by the job.
Function may be called only after required inputs are assigned; this is provided by class JobNode, the job should not be used directly.
- Parameters
-
global Global settings, shared by all jobs. Contains parameters like number of threads, etc. callbacks Interface allowing to get notified about current progress of the job.
- Exceptions
-
InvalidSetup if required input is missing or job encountered a problem in initialization.
Implements IJob.
Definition at line 640 of file GeometryJobs.cpp.
◆ getSettings()
|
overridevirtual |
Returns a settings object which allows to query and modify the state of the job.
It is not necessary to expose all state variables this way. This is mainly intended for (de)serialization of the job state and for connection with UI controls.
Implements IJob.
Definition at line 646 of file GeometryJobs.cpp.
◆ getSlots()
|
inlineoverridevirtual |
Lists all potential inputs of the job.
This is the superset of slots returned by function requires and it has to be fixed, i.e. cannot change when internal state of the job changes.
Implements IJob.
Definition at line 273 of file GeometryJobs.h.
The documentation for this class was generated from the following files:
- /home/pavel/projects/astro/sph/src/core/run/jobs/GeometryJobs.h
- /home/pavel/projects/astro/sph/src/core/run/jobs/GeometryJobs.cpp
