#include <MaterialJobs.h>
Public Member Functions | |
| MaterialJob (const std::string &name, const BodySettings &overrides=EMPTY_SETTINGS) | |
| 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 &UNUSED(callbacks)) override |
 Public Member Functions inherited from IMaterialJob | |
| IMaterialJob (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... | |
| virtual void | evaluate (const RunSettings &global, IRunCallbacks &callbacks)=0 |
| Runs the operation provided by the job. More... | |
| Public Member Functions inherited from Polymorphic | |
| virtual | ~Polymorphic () |
| Public Member Functions inherited from MaterialProvider | |
| MaterialProvider (const BodySettings &overrides=EMPTY_SETTINGS) | |
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 Member Functions inherited from MaterialProvider | |
| void | addMaterialEntries (VirtualSettings::Category &category, Function< bool()> enabler) |
| Protected Attributes inherited from IMaterialJob | |
| SharedPtr< IMaterial > | 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... | |
| Protected Attributes inherited from MaterialProvider | |
| BodySettings | body |
Detailed Description
Definition at line 18 of file MaterialJobs.h.
Constructor & Destructor Documentation
◆ MaterialJob()
| MaterialJob::MaterialJob | ( | const std::string & | name, |
| const BodySettings & | overrides = EMPTY_SETTINGS |
||
| ) |
Definition at line 93 of file MaterialJobs.cpp.
Member Function Documentation
◆ className()
|
inlineoverridevirtual |
Name representing the type of the job (e.e. "SPH").
Implements IJob.
Definition at line 22 of file MaterialJobs.h.
◆ evaluate()
|
overridevirtual |
Definition at line 134 of file MaterialJobs.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 97 of file MaterialJobs.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 26 of file MaterialJobs.h.
The documentation for this class was generated from the following files:
- /home/pavel/projects/astro/sph/src/core/run/jobs/MaterialJobs.h
- /home/pavel/projects/astro/sph/src/core/run/jobs/MaterialJobs.cpp
