Base class for jobs providing no data. More...

#include <Job.h>

Inheritance diagram for INullJob:

Public Member Functions
	INullJob (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 std::string	className () const =0
	Name representing the type of the job (e.e. "SPH"). More...

virtual UnorderedMap< std::string, ExtJobType >	requires () const
	List of slots that need to be connected to evaluate the job. More...

virtual UnorderedMap< std::string, ExtJobType >	getSlots () 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 ()

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 IJob
std::string	instName

UnorderedMap< std::string, JobContext >	inputs
	Contains all input data, identified by names of input slots. More...

Detailed Description

Base class for jobs providing no data.

Definition at line 322 of file Job.h.

Constructor & Destructor Documentation

◆ INullJob()

INullJob::INullJob ( const std::string & name )

inlineexplicit

Definition at line 324 of file Job.h.

Member Function Documentation

◆ getResult()

virtual JobContext INullJob::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 331 of file Job.h.

◆ provides()

virtual Optional<ExtJobType> INullJob::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 327 of file Job.h.

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

/home/pavel/projects/astro/sph/src/core/run/Job.h