NBodyJob Class Reference

#include <SimulationJobs.h>

Inheritance diagram for NBodyJob:

Public Member Functions
	NBodyJob (const std::string &name, const RunSettings &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 AutoPtr< IRun >	getRun (const RunSettings &overrides) const override
	Returns the actual simulation object. More...
Public Member Functions inherited from IRunJob
	IRunJob (const std::string &name)
	~IRunJob () override
Public Member Functions inherited from IParticleJob
	IParticleJob (const std::string &name)
	~IParticleJob () override
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...
Public Member Functions inherited from Polymorphic
virtual	~Polymorphic ()
Public Member Functions inherited from SharedToken
	SharedToken ()
	SharedToken (std::nullptr_t)
	SharedToken (const SharedToken &other)
template<typename T >
	SharedToken (const SharedPtr< T > &ptr)
SharedToken &	operator= (const SharedToken &other)
	~SharedToken ()
void	reset ()
INLINE	operator bool () const
INLINE bool	operator! () const

Static Public Member Functions
static RunSettings	getDefaultSettings (const std::string &name)

Additional Inherited Members
Protected Member Functions inherited from IRunJob
virtual void	evaluate (const RunSettings &global, IRunCallbacks &callbacks) override final
	Runs the operation provided by the job. More...
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 IParticleJob
SharedPtr< ParticleData >	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...

Detailed Description

Definition at line 52 of file SimulationJobs.h.

Constructor & Destructor Documentation

NBodyJob()

NBodyJob::NBodyJob ( const std::string &  name, const RunSettings &  overrides = EMPTY_SETTINGS  )

explicit

Definition at line 440 of file SimulationJobs.cpp.

Member Function Documentation

className()

virtual std::string NBodyJob::className ( ) const

inlineoverridevirtual

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

Implements IJob.

Definition at line 63 of file SimulationJobs.h.

getDefaultSettings()

RunSettings NBodyJob::getDefaultSettings ( const std::string &  name )

static

Definition at line 447 of file SimulationJobs.cpp.

getRun()

AutoPtr< IRun > NBodyJob::getRun ( const RunSettings &  overrides ) const

overridevirtual

Returns the actual simulation object.

This provides a way to implement the job functionality, as function evaluate is final and used only internally.

Parameters

overrides

Settings overriding the current settings of the job.

Implements IRunJob.

Definition at line 542 of file SimulationJobs.cpp.

getSettings()

VirtualSettings NBodyJob::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 481 of file SimulationJobs.cpp.

getSlots()

virtual UnorderedMap<std::string, ExtJobType> NBodyJob::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 67 of file SimulationJobs.h.

---

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

• /home/pavel/projects/astro/sph/src/core/run/jobs/SimulationJobs.h
• /home/pavel/projects/astro/sph/src/core/run/jobs/SimulationJobs.cpp