SPH
Public Member Functions | Protected Attributes | List of all members
IGeometryJob Class Reference

Base class for jobs providing a geometric shape. More...

#include <Job.h>

Inheritance diagram for IGeometryJob:
IJob Polymorphic BlockJob BooleanGeometryJob CylinderJob EllipsoidJob GaussianSphereJob HalfSpaceJob InvertGeometryJob MaclaurinSpheroidJob MeshGeometryJob ParticleGeometryJob SphereJob SpheresGeometryJob TransformGeometryJob

Public Member Functions

 IGeometryJob (const std::string &name)
 
virtual Optional< ExtJobTypeprovides () 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 std::string className () const =0
 Name representing the type of the job (e.e. "SPH"). More...
 
virtual UnorderedMap< std::string, ExtJobTyperequires () const
 List of slots that need to be connected to evaluate the job. More...
 
virtual UnorderedMap< std::string, ExtJobTypegetSlots () const =0
 Lists all potential inputs of the job. More...
 
virtual VirtualSettings getSettings ()=0
 Returns a settings object which allows to query and modify the state of 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 ()
 

Protected Attributes

SharedPtr< IDomainresult
 Data filled by the job when it finishes. More...
 
- Protected Attributes inherited from IJob
std::string instName
 
UnorderedMap< std::string, JobContextinputs
 Contains all input data, identified by names of input slots. More...
 

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...
 

Detailed Description

Base class for jobs providing a geometric shape.

Definition at line 284 of file Job.h.

Constructor & Destructor Documentation

◆ IGeometryJob()

IGeometryJob::IGeometryJob ( const std::string &  name)
inlineexplicit

Definition at line 290 of file Job.h.

Member Function Documentation

◆ getResult()

virtual JobContext IGeometryJob::getResult ( ) const
inlinefinaloverridevirtual

Returns the result of the job.

This can only be called after the job is evaluated. The result is cached by the job, so the function getResult can be called multiple times once the job finishes.

Implements IJob.

Definition at line 297 of file Job.h.

◆ provides()

virtual Optional<ExtJobType> IGeometryJob::provides ( ) const
inlinefinaloverridevirtual

Specifies the type of the job, i.e. what kind of data the job provides.

May be NOTHING for jobs like "save file", etc.

Implements IJob.

Definition at line 293 of file Job.h.

Member Data Documentation

◆ result

SharedPtr<IDomain> IGeometryJob::result
protected

Data filled by the job when it finishes.

Definition at line 287 of file Job.h.


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