ICameraJob Class Reference

#include <CameraJobs.h>

Inheritance diagram for ICameraJob:

Public Member Functions
	ICameraJob (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...
virtual UnorderedMap< std::string, ExtJobType >	getSlots () const override
	Lists all potential inputs 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 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 VirtualSettings	getSettings ()=0
	Returns a settings object which allows to query and modify the state of the job. More...
Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()

Protected Attributes
GuiSettings	gui
Protected Attributes inherited from IJob
std::string	instName
UnorderedMap< std::string, JobContext >	inputs
	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

Definition at line 22 of file CameraJobs.h.

Constructor & Destructor Documentation

ICameraJob()

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

inlineexplicit

Definition at line 30 of file CameraJobs.h.

Member Function Documentation

evaluate()

NAMESPACE_SPH_BEGIN void ICameraJob::evaluate ( const RunSettings &  global, IRunCallbacks &  callbacks  )

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 6 of file CameraJobs.cpp.

getResult()

virtual JobContext ICameraJob::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 37 of file CameraJobs.h.

getSlots()

virtual UnorderedMap<std::string, ExtJobType> ICameraJob::getSlots ( ) const

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 41 of file CameraJobs.h.

provides()

virtual Optional<ExtJobType> ICameraJob::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 33 of file CameraJobs.h.

Member Data Documentation

gui

GuiSettings ICameraJob::gui

protected

Definition at line 27 of file CameraJobs.h.

---

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

• /home/pavel/projects/astro/sph/src/gui/objects/CameraJobs.h
• /home/pavel/projects/astro/sph/src/gui/objects/CameraJobs.cpp