TYCheminDefaultSolver Class Reference

Representation of one of the most optimal path between source and receptor: S—>R. The class TYChemin represents a path between a Source and a receptor (Recepteur class). It's constituted of a collection of steps (TYEtape class). Specific derivation of TYChemin for DefaultSolver. More...

#include <TYCheminDefaultSolver.h>

Inheritance diagram for TYCheminDefaultSolver:

Collaboration diagram for TYCheminDefaultSolver:

Public Member Functions
	TYCheminDefaultSolver ()
	Constructor. More...
	TYCheminDefaultSolver (const TYCheminDefaultSolver &other)
	Copy contructor. More...
TYCheminDefaultSolver &	operator= (const TYCheminDefaultSolver &other)
	Operator =. More...
bool	operator== (const TYCheminDefaultSolver &other) const
	Operator ==. More...
bool	operator!= (const TYCheminDefaultSolver &other) const
	Operator !=. More...
void	calcAttenuation (const TYTabEtapeDefaultSolver &tabEtapes, const AtmosphericConditions &atmos)
	Compute the global attenuation on the path. More...
OSpectreComplex &	getAttenuation ()
	Return the path attenuation. More...
const OSpectreComplex &	getAttenuation () const
void	setAttenuation (const OSpectreComplex &att)
	Set the attenuation. More...
Public Member Functions inherited from TYChemin
	TYChemin ()
	Constructor. More...
	TYChemin (const TYChemin &other)
	Copy contructor. More...
virtual	~TYChemin ()
	Destructor. More...
TYChemin &	operator= (const TYChemin &other)
	Operator =. More...
bool	operator== (const TYChemin &other) const
	Operator ==. More...
bool	operator!= (const TYChemin &other) const
	Operator !=. More...
double	getLongueur ()
	Get/Set the path length. More...
const double	getLongueur () const
void	setLongueur (const double &longueur)
double	getDistance ()
	Get/Set the distance between source and receptor. More...
const double	getDistance () const
void	setDistance (const double &distance)
void	setType (const TYTypeChemin &type)
	Change the path type. More...
const TYTypeChemin	getType () const
	Return the path type. More...
template<typename T >
void	build_eq_path (const T &tabEtapes)
	build an acoustic_path from the tab of etapes More...
acoustic_path *	get_ray (OPoint3D ptR)

Protected Attributes
OSpectreComplex	_attenuation
	Attenuation spectrum of the path. More...
Protected Attributes inherited from TYChemin
TYTypeChemin	_typeChemin
	Path type (has an influence on the algorithm) More...
double	_longueur
	Total path length. More...
double	_distance
	Direct distance between source and receptor. More...
acoustic_path *	_eq_path
	Equivalent acoustic_path. More...

Detailed Description

Representation of one of the most optimal path between source and receptor: S—>R. The class TYChemin represents a path between a Source and a receptor (Recepteur class). It's constituted of a collection of steps (TYEtape class). Specific derivation of TYChemin for DefaultSolver.

Definition at line 40 of file TYCheminDefaultSolver.h.

Constructor & Destructor Documentation

TYCheminDefaultSolver() [1/2]

TYCheminDefaultSolver::TYCheminDefaultSolver

(

)

Constructor.

Definition at line 19 of file TYCheminDefaultSolver.cpp.

Here is the call graph for this function:

TYCheminDefaultSolver() [2/2]

TYCheminDefaultSolver::TYCheminDefaultSolver

(

const TYCheminDefaultSolver &

other

)

Copy contructor.

Definition at line 24 of file TYCheminDefaultSolver.cpp.

Member Function Documentation

calcAttenuation()

void TYCheminDefaultSolver::calcAttenuation	(	const TYTabEtapeDefaultSolver &	tabEtapes,
		const AtmosphericConditions &	atmos
	)

Compute the global attenuation on the path.

Definition at line 62 of file TYCheminDefaultSolver.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

getAttenuation() [1/2]

OSpectreComplex & TYCheminDefaultSolver::getAttenuation ( )

inline

Return the path attenuation.

const OSpectreComplex& getAttenuation()

Returns

_attenuation

Definition at line 74 of file TYCheminDefaultSolver.h.

getAttenuation() [2/2]

const OSpectreComplex& TYCheminDefaultSolver::getAttenuation ( ) const

inline

Definition at line 78 of file TYCheminDefaultSolver.h.

operator!=()

bool TYCheminDefaultSolver::operator!=

(

const TYCheminDefaultSolver &

other

)

const

Operator !=.

Definition at line 57 of file TYCheminDefaultSolver.cpp.

Here is the call graph for this function:

operator=()

TYCheminDefaultSolver & TYCheminDefaultSolver::operator=

(

const TYCheminDefaultSolver &

other

)

Operator =.

Definition at line 29 of file TYCheminDefaultSolver.cpp.

Here is the call graph for this function:

operator==()

bool TYCheminDefaultSolver::operator==

(

const TYCheminDefaultSolver &

other

)

const

Operator ==.

Definition at line 40 of file TYCheminDefaultSolver.cpp.

Here is the caller graph for this function:

setAttenuation()

void TYCheminDefaultSolver::setAttenuation ( const OSpectreComplex &  att )

inline

Set the attenuation.

Definition at line 87 of file TYCheminDefaultSolver.h.

Member Data Documentation

_attenuation

OSpectreComplex TYCheminDefaultSolver::_attenuation

protected

Attenuation spectrum of the path.

Definition at line 94 of file TYCheminDefaultSolver.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/TYCheminDefaultSolver.h
• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_886/Tympan/solvers/9613/DefaultSolver/TYCheminDefaultSolver.cpp