This class TYTrajet (journey) links a couple Source-Receptor and a collection of paths, in addition to the direct path. Specific derivation of TYTrajet for DefaultSolver. More...

#include <TYTrajetDefaultSolver.h>

Inheritance diagram for TYTrajetDefaultSolver:

[legend]

Collaboration diagram for TYTrajetDefaultSolver:

[legend]

Public Member Functions
	TYTrajetDefaultSolver (tympan::AcousticSource &asrc_, tympan::AcousticReceptor &arcpt_)
	Constructor. More...

virtual	~TYTrajetDefaultSolver ()
	Destructor. More...

TYTrajetDefaultSolver &	operator= (const TYTrajetDefaultSolver &other)
	Operator =. More...

bool	operator== (const TYTrajetDefaultSolver &other) const
	Operator ==. More...

bool	operator!= (const TYTrajetDefaultSolver &other) const
	Operator !=. More...

void	reset () override
	Reset method. More...

size_t	getNbChemins ()
	Return the number of path in *this (in addition to the direct path). More...

TYTabCheminDefaultSolver &	getChemins ()
	Return the collection of paths of *this. More...

TYTabCheminDefaultSolver &	getCheminsDirect ()
	Return an array of the direct paths. More...

void	addChemin (const TYCheminDefaultSolver &chemin)
	Add a new path. More...

void	addCheminDirect (const TYCheminDefaultSolver &chemin)
	Add a new path to the array of direct paths. More...

TYCheminDefaultSolver	getChemin (int index)
	Return a path thanks to its index. More...

OSpectre &	getSpectre ()
	Get/Set the spectrum at the receptor point. More...

const OSpectre	getSpectre () const

void	setSpectre (const OSpectre &spectre)

OSpectre	getPEnergetique (const AtmosphericConditions &atmos)
	Compute the acoustic pressure (phase modulation) on the journey. More...

OSpectre	getPInterference (const AtmosphericConditions &atmos)
	Compute the quadratic pressure on the journey. More...

Public Member Functions inherited from TYTrajet
	TYTrajet (tympan::AcousticSource &asrc_, tympan::AcousticReceptor &arcpt_)
	Constructor. More...

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

virtual	~TYTrajet ()
	Destructor. More...

TYTrajet &	operator= (const TYTrajet &other)
	Operator =. More...

bool	operator== (const TYTrajet &other) const
	Operator ==. More...

bool	operator!= (const TYTrajet &other) const
	Operator !=. More...

double	getDistance ()
	Get/Set the distance between source and receptor. More...

const double	getDistance () const

void	setDistance (const double &distance)

void	setPtSetPtR (const OPoint3D &pt1, const OPoint3D &pt2)
	Get/Set points for source and receptor. More...

void	getPtSetPtR (OPoint3D &pt1, OPoint3D &pt2)

void	setPtSetPtRfromOSeg3D (const OSegment3D &seg)
	Get/Set points for source and receptor with an OSegment3D. More...

void	getPtSetPtRfromOSeg3D (OSegment3D &seg) const

std::vector< acoustic_path * > &	get_tab_rays ()

Protected Attributes
TYTabCheminDefaultSolver	_chemins
	Paths collection. More...

TYTabCheminDefaultSolver	_cheminsDirect
	Direct paths collection (without obstacles) More...

OSpectre	_sLP

Protected Attributes inherited from TYTrajet
OPoint3D	_ptS
	Source point definition in the site frame. More...

OPoint3D	_ptR
	Receptor point definition in the site frame. More...

double	_distance
	Distance between source and receptor. More...

std::vector< acoustic_path * >	_tabRays
	Vector of rays equivalent to chemin. More...

Private Member Functions
OSpectre	correctTiers (const OSpectreComplex &si, const OSpectreComplex &sj, const AtmosphericConditions &atmos, const double &ri, const double &rj) const

void	build_tab_rays ()

	FRIEND_TEST (test_TYTrajet, getPInterference)

	FRIEND_TEST (test_TYTrajet, getPEnergetique)

Additional Inherited Members
Public Attributes inherited from TYTrajet
tympan::AcousticSource &	asrc
	Business source. More...

tympan::source_idx	asrc_idx

tympan::AcousticReceptor &	arcpt
	Business receptor. More...

tympan::receptor_idx	arcpt_idx

Detailed Description

This class TYTrajet (journey) links a couple Source-Receptor and a collection of paths, in addition to the direct path. Specific derivation of TYTrajet for DefaultSolver.

Version: v 1.0

Date: 2014/01/17

Author: Projet_Tympan

Definition at line 36 of file TYTrajetDefaultSolver.h.

Constructor & Destructor Documentation

◆ TYTrajetDefaultSolver()

TYTrajetDefaultSolver::TYTrajetDefaultSolver	(	tympan::AcousticSource &	asrc_,
		tympan::AcousticReceptor &	arcpt_
	)

Constructor.

Parameters

asrc_	Source
arcpt_	Receptor

Definition at line 19 of file TYTrajetDefaultSolver.cpp.

◆ ~TYTrajetDefaultSolver()

TYTrajetDefaultSolver::~TYTrajetDefaultSolver ( )

virtual

Destructor.

Definition at line 24 of file TYTrajetDefaultSolver.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ addChemin()

void TYTrajetDefaultSolver::addChemin ( const TYCheminDefaultSolver & chemin )

Add a new path.

Definition at line 74 of file TYTrajetDefaultSolver.cpp.

◆ addCheminDirect()

void TYTrajetDefaultSolver::addCheminDirect ( const TYCheminDefaultSolver & chemin )

Add a new path to the array of direct paths.

Definition at line 79 of file TYTrajetDefaultSolver.cpp.

◆ build_tab_rays()

void TYTrajetDefaultSolver::build_tab_rays ( )

private

Definition at line 363 of file TYTrajetDefaultSolver.cpp.

Here is the caller graph for this function:

◆ correctTiers()

OSpectre TYTrajetDefaultSolver::correctTiers	(	const OSpectreComplex &	si,
		const OSpectreComplex &	sj,
		const AtmosphericConditions &	atmos,
		const double &	ri,
		const double &	rj
	)		const

private

Definition at line 325 of file TYTrajetDefaultSolver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ FRIEND_TEST() [1/2]

TYTrajetDefaultSolver::FRIEND_TEST	(	test_TYTrajet	,
		getPEnergetique
	)

private

◆ FRIEND_TEST() [2/2]

TYTrajetDefaultSolver::FRIEND_TEST	(	test_TYTrajet	,
		getPInterference
	)

private

◆ getChemin()

TYCheminDefaultSolver TYTrajetDefaultSolver::getChemin ( int index )

inline

Return a path thanks to its index.

Returns: _chemins.at(index)

Definition at line 115 of file TYTrajetDefaultSolver.h.

◆ getChemins()

TYTabCheminDefaultSolver & TYTrajetDefaultSolver::getChemins ( )

inline

Return the collection of paths of *this.

Returns: _chemins

Definition at line 83 of file TYTrajetDefaultSolver.h.

Here is the caller graph for this function:

◆ getCheminsDirect()

TYTabCheminDefaultSolver & TYTrajetDefaultSolver::getCheminsDirect ( )

inline

Return an array of the direct paths.

Returns: _cheminsDirect

Definition at line 93 of file TYTrajetDefaultSolver.h.

Here is the caller graph for this function:

◆ getNbChemins()

size_t TYTrajetDefaultSolver::getNbChemins ( )

inline

Return the number of path in *this (in addition to the direct path).

Returns: _chemins.size()

Definition at line 73 of file TYTrajetDefaultSolver.h.

◆ getPEnergetique()

OSpectre TYTrajetDefaultSolver::getPEnergetique ( const AtmosphericConditions & atmos )

Compute the acoustic pressure (phase modulation) on the journey.

Definition at line 84 of file TYTrajetDefaultSolver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPInterference()

OSpectre TYTrajetDefaultSolver::getPInterference ( const AtmosphericConditions & atmos )

Compute the quadratic pressure on the journey.

Definition at line 155 of file TYTrajetDefaultSolver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpectre() [1/2]

OSpectre & TYTrajetDefaultSolver::getSpectre ( )

inline

Get/Set the spectrum at the receptor point.

const OSpectre getSpectre() void setSpectre(const OSpectre& spectre)

Returns: _sLP

Definition at line 127 of file TYTrajetDefaultSolver.h.

Here is the caller graph for this function:

◆ getSpectre() [2/2]

const OSpectre TYTrajetDefaultSolver::getSpectre ( ) const

inline

Definition at line 131 of file TYTrajetDefaultSolver.h.

◆ operator!=()

bool TYTrajetDefaultSolver::operator!= ( const TYTrajetDefaultSolver & other ) const

Operator !=.

Definition at line 69 of file TYTrajetDefaultSolver.cpp.

Here is the call graph for this function:

◆ operator=()

TYTrajetDefaultSolver & TYTrajetDefaultSolver::operator= ( const TYTrajetDefaultSolver & other )

Operator =.

Definition at line 35 of file TYTrajetDefaultSolver.cpp.

Here is the call graph for this function:

◆ operator==()

bool TYTrajetDefaultSolver::operator== ( const TYTrajetDefaultSolver & other ) const

Operator ==.

Definition at line 46 of file TYTrajetDefaultSolver.cpp.

Here is the caller graph for this function:

◆ reset()

void TYTrajetDefaultSolver::reset ( void )

overridevirtual

Reset method.

Implements TYTrajet.

Definition at line 29 of file TYTrajetDefaultSolver.cpp.

Here is the caller graph for this function:

◆ setSpectre()

void TYTrajetDefaultSolver::setSpectre ( const OSpectre & spectre )

inline

Definition at line 135 of file TYTrajetDefaultSolver.h.

Member Data Documentation

◆ _chemins

TYTabCheminDefaultSolver TYTrajetDefaultSolver::_chemins

protected

Paths collection.

Definition at line 163 of file TYTrajetDefaultSolver.h.

◆ _cheminsDirect

TYTabCheminDefaultSolver TYTrajetDefaultSolver::_cheminsDirect

protected

Direct paths collection (without obstacles)

Definition at line 166 of file TYTrajetDefaultSolver.h.

◆ _sLP

OSpectre TYTrajetDefaultSolver::_sLP

protected

Definition at line 168 of file TYTrajetDefaultSolver.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_886/Tympan/solvers/9613/DefaultSolver/TYTrajetDefaultSolver.h
/home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_886/Tympan/solvers/9613/DefaultSolver/TYTrajetDefaultSolver.cpp

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TYTrajetDefaultSolver()

◆ ~TYTrajetDefaultSolver()

Member Function Documentation

◆ addChemin()

◆ addCheminDirect()

◆ build_tab_rays()

◆ correctTiers()

◆ FRIEND_TEST() [1/2]

◆ FRIEND_TEST() [2/2]

◆ getChemin()

◆ getChemins()

◆ getCheminsDirect()

◆ getNbChemins()

◆ getPEnergetique()

◆ getPInterference()

◆ getSpectre() [1/2]

◆ getSpectre() [2/2]

◆ operator!=()

◆ operator=()

◆ operator==()

◆ reset()

◆ setSpectre()

Member Data Documentation

◆ _chemins

◆ _cheminsDirect

◆ _sLP