#include <DefaultEngine.h>

Inheritance diagram for DefaultEngine:

Collaboration diagram for DefaultEngine:

Public Member Functions
	DefaultEngine ()
	Constructors. More...

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

	DefaultEngine (const DefaultEngine &other)
	Copy constructor. More...

virtual	~DefaultEngine ()
	Destructor. 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...

Ray *	genRay ()
	Create rays from the sources. More...

Public Member Functions inherited from Engine
	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 unsigned long long int	getRayCounter ()

Protected Member Functions
void	searchForReceptor (const decimal &tmin, Ray *r)
	Search if a ray intersects a receptor before traveling a tmin distance (NB: this is the only place in the code where a ray is added to the solver's list of valid rays) More...

void	initialReceptorTargeting ()
	Initialize the rays treatment stack by a loop on the receptors. More...

void	copyRayAndAddToStack (Ray *r)
	Copy a ray and use its last event to generate a response to use as the copy's direction (used to handle the generation of rays by diffraction events) More...

virtual bool	traitementRay (Ray *r, std::list< validRay > &result)
	Ray treatment method. More...

Protected Attributes
std::stack< Ray , std::deque< Ray > >	pile_traitement
	Treatment stack containing the rays to treat. More...

unsigned long long int	nbRayonsTraites
	Treated rays number. More...

Protected Attributes inherited from Engine
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

Default Engine class.

Definition at line 25 of file DefaultEngine.h.

Constructor & Destructor Documentation

◆ DefaultEngine() [1/3]

DefaultEngine::DefaultEngine ( )

inline

Constructors.

Definition at line 30 of file DefaultEngine.h.

◆ DefaultEngine() [2/3]

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

inline

Definition at line 35 of file DefaultEngine.h.

◆ DefaultEngine() [3/3]

DefaultEngine::DefaultEngine ( const DefaultEngine & other )

inline

Copy constructor.

Definition at line 40 of file DefaultEngine.h.

◆ ~DefaultEngine()

virtual DefaultEngine::~DefaultEngine ( )

inlinevirtual

Destructor.

Definition at line 48 of file DefaultEngine.h.

Member Function Documentation

◆ copyRayAndAddToStack()

void DefaultEngine::copyRayAndAddToStack ( Ray * r )

inlineprotected

Copy a ray and use its last event to generate a response to use as the copy's direction (used to handle the generation of rays by diffraction events)

Parameters

r	Return modified ray

Definition at line 223 of file DefaultEngine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ genRay()

Ray * DefaultEngine::genRay ( )

Create rays from the sources.

Definition at line 132 of file DefaultEngine.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initialReceptorTargeting()

void DefaultEngine::initialReceptorTargeting ( )

inlineprotected

Initialize the rays treatment stack by a loop on the receptors.

Definition at line 109 of file DefaultEngine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process()

bool DefaultEngine::process ( )

virtual

If implemented, process and return true if success.

Reimplemented from Engine.

Definition at line 61 of file DefaultEngine.cpp.

Here is the call graph for this function:

◆ runStructureBenchmark()

void DefaultEngine::runStructureBenchmark ( )

virtual

If implemented, run a benchmark for the engine.

Reimplemented from Engine.

Definition at line 237 of file DefaultEngine.cpp.

Here is the call graph for this function:

◆ searchForReceptor()

void DefaultEngine::searchForReceptor	(	const decimal &	tmin,
		Ray *	r
	)

inlineprotected

Search if a ray intersects a receptor before traveling a tmin distance (NB: this is the only place in the code where a ray is added to the solver's list of valid rays)

Parameters

tmin	maximum distance the ray can travel before hiting a receptor for the intersection to be considered valid
r	The ray

Definition at line 64 of file DefaultEngine.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ traitementRay()

bool DefaultEngine::traitementRay	(	Ray *	r,
		std::list< validRay > &	result
	)

protectedvirtual

Ray treatment method.

Parameters

r	Ray to treat
result	Updated valid rays list

Returns

Definition at line 157 of file DefaultEngine.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ nbRayonsTraites

unsigned long long int DefaultEngine::nbRayonsTraites

protected

Treated rays number.

Definition at line 249 of file DefaultEngine.h.

◆ pile_traitement

std::stack<Ray*, std::deque<Ray*> > DefaultEngine::pile_traitement

protected

Treatment stack containing the rays to treat.

Definition at line 247 of file DefaultEngine.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Engine/DefaultEngine.h
/home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/geometric_methods/AcousticRaytracer/Engine/DefaultEngine.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ DefaultEngine() [1/3]

◆ DefaultEngine() [2/3]

◆ DefaultEngine() [3/3]

◆ ~DefaultEngine()

Member Function Documentation

◆ copyRayAndAddToStack()

◆ genRay()

◆ initialReceptorTargeting()

◆ process()

◆ runStructureBenchmark()

◆ searchForReceptor()

◆ traitementRay()

Member Data Documentation

◆ nbRayonsTraites

◆ pile_traitement