SPH
Public Member Functions | List of all members
VdbJob Class Reference

#include <RenderJobs.h>

Inheritance diagram for VdbJob:
INullJob IJob Polymorphic

Public Member Functions

 VdbJob (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, ExtJobTypegetSlots () const override
 Lists all potential inputs of the job. More...
 
virtual UnorderedMap< std::string, ExtJobTyperequires () const override
 List of slots that need to be connected to evaluate 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 INullJob
 INullJob (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 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, JobContextinputs
 Contains all input data, identified by names of input slots. More...
 

Detailed Description

Definition at line 99 of file RenderJobs.h.

Constructor & Destructor Documentation

◆ VdbJob()

VdbJob::VdbJob ( const std::string &  name)
inline

Definition at line 114 of file RenderJobs.h.

Member Function Documentation

◆ className()

virtual std::string VdbJob::className ( ) const
inlineoverridevirtual

Name representing the type of the job (e.e. "SPH").

Implements IJob.

Definition at line 117 of file RenderJobs.h.

◆ evaluate()

virtual void VdbJob::evaluate ( const RunSettings global,
IRunCallbacks UNUSEDcallbacks 
)
overridevirtual

◆ getSettings()

virtual VirtualSettings VdbJob::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.

◆ getSlots()

virtual UnorderedMap<std::string, ExtJobType> VdbJob::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 121 of file RenderJobs.h.

◆ requires()

virtual UnorderedMap<std::string, ExtJobType> VdbJob::requires ( ) const
inlineoverridevirtual

List of slots that need to be connected to evaluate the job.

The returned map shall contain names of the slots and their types. No two slots can have the same name. This list can can be changed, based on internal state of the job.

Reimplemented from IJob.

Definition at line 126 of file RenderJobs.h.

Member Data Documentation

◆ enabled

bool VdbJob::enabled = false

Definition at line 107 of file RenderJobs.h.

◆ firstFile

Path VdbJob::firstFile = Path("out_0000.ssf")

Definition at line 108 of file RenderJobs.h.


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