Engine Class Reference

Base class for engines (DefaultEngine, ParallelDefaultEngine,...) More...

#include <Engine.h>

Inheritance diagram for Engine:

Collaboration diagram for Engine:

Public Member Functions
	Engine ()
	Default constructor. More...
	Engine (Scene *_scene, std::vector< Source > *_sources, Solver *_solver, Scene *_recepteurs)
	Constructor. More...
	Engine (const Engine &other)
	Copy constructor. More...
virtual	~Engine ()
	Destructor. More...
Scene *	getScene ()
	Get the Scene. More...
void	setScene (Scene *_scene)
	Set the Scene. More...
std::vector< Source > *	getSources ()
	Get the Sources. More...
void	setSources (std::vector< Source > *_sources)
	Set the Sources. More...
Solver *	getSolver ()
	Get the Solver. More...
void	setSolver (Solver *_solver)
	Set the Solver. More...
virtual bool	process ()
	If implemented, process and return true if success. More...
virtual void	runStructureBenchmark ()
	If implemented, run a benchmark for the engine. More...
virtual unsigned long long int	getRayCounter ()

Protected Attributes
Scene *	scene
	Pointer to the scene. More...
std::vector< Source > *	sources
	Pointer to all the receptors. More...
Scene *	recepteurs
	Pointer to all the sources. More...
Solver *	solver
	Pointer to the solver. More...
unsigned long long int	rayCounter
	Ray counter. More...

Detailed Description

Base class for engines (DefaultEngine, ParallelDefaultEngine,...)

Definition at line 35 of file Engine.h.

Constructor & Destructor Documentation

Engine() [1/3]

Engine::Engine ( )

inline

Default constructor.

Definition at line 41 of file Engine.h.

Here is the caller graph for this function:

Engine() [2/3]

Engine::Engine ( Scene *  _scene, std::vector< Source > *  _sources, Solver *  _solver, Scene *  _recepteurs  )

inline

Constructor.

Definition at line 43 of file Engine.h.

Engine() [3/3]

Engine::Engine ( const Engine &  other )

inline

Copy constructor.

Definition at line 52 of file Engine.h.

~Engine()

virtual Engine::~Engine ( )

inlinevirtual

Destructor.

Definition at line 61 of file Engine.h.

Member Function Documentation

getRayCounter()

virtual unsigned long long int Engine::getRayCounter ( )

inlinevirtual

Definition at line 76 of file Engine.h.

getScene()

Scene* Engine::getScene ( )

inline

Get the Scene.

Definition at line 63 of file Engine.h.

getSolver()

Solver* Engine::getSolver ( )

inline

Get the Solver.

Definition at line 69 of file Engine.h.

getSources()

std::vector<Source>* Engine::getSources ( )

inline

Get the Sources.

Definition at line 66 of file Engine.h.

process()

virtual bool Engine::process ( )

inlinevirtual

If implemented, process and return true if success.

Reimplemented in DefaultCurvRayEngine, DefaultEngine, and ParallelDefaultEngine.

Definition at line 72 of file Engine.h.

Here is the caller graph for this function:

runStructureBenchmark()

virtual void Engine::runStructureBenchmark ( )

inlinevirtual

If implemented, run a benchmark for the engine.

Reimplemented in DefaultEngine.

Definition at line 74 of file Engine.h.

setScene()

void Engine::setScene ( Scene *  _scene )

inline

Set the Scene.

Definition at line 64 of file Engine.h.

setSolver()

void Engine::setSolver ( Solver *  _solver )

inline

Set the Solver.

Definition at line 70 of file Engine.h.

setSources()

void Engine::setSources ( std::vector< Source > *  _sources )

inline

Set the Sources.

Definition at line 67 of file Engine.h.

Member Data Documentation

rayCounter

unsigned long long int Engine::rayCounter

protected

Ray counter.

Definition at line 84 of file Engine.h.

recepteurs

Scene* Engine::recepteurs

protected

Pointer to all the sources.

Definition at line 81 of file Engine.h.

scene

Scene* Engine::scene

protected

Pointer to the scene.

Definition at line 79 of file Engine.h.

solver

Solver* Engine::solver

protected

Pointer to the solver.

Definition at line 82 of file Engine.h.

sources

std::vector<Source>* Engine::sources

protected

Pointer to all the receptors.

Definition at line 80 of file Engine.h.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Engine/Engine.h