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). More...

#include <TYChemin.h>

Collaboration diagram for TYChemin:

[legend]

Public Member Functions
	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...

void	calcAttenuation (const TYTabEtape &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...

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 int &type)
	Change the path type. More...

int	getType () const
	Return the path type. More...

void	build_eq_path (const TYTabEtape &tabEtapes)
	build an acoustic_path from the tab of etapes More...

acoustic_path *	get_ray (OPoint3D ptR)

Protected Attributes
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...

OSpectreComplex	_attenuation
	Attenuation spectrum of the path. 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).

Definition at line 38 of file TYChemin.h.

Constructor & Destructor Documentation

◆ TYChemin() [1/2]

TYChemin::TYChemin ( )

Constructor.

Definition at line 20 of file TYChemin.cpp.

Here is the call graph for this function:

◆ TYChemin() [2/2]

TYChemin::TYChemin ( const TYChemin & other )

Copy contructor.

Definition at line 26 of file TYChemin.cpp.

◆ ~TYChemin()

TYChemin::~TYChemin ( )

virtual

Destructor.

Definition at line 31 of file TYChemin.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ build_eq_path()

void TYChemin::build_eq_path ( const TYTabEtape & tabEtapes )

build an acoustic_path from the tab of etapes

Definition at line 150 of file TYChemin.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ calcAttenuation()

void TYChemin::calcAttenuation	(	const TYTabEtape &	tabEtapes,
		const AtmosphericConditions &	atmos
	)

Compute the global attenuation on the path.

Definition at line 72 of file TYChemin.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ get_ray()

acoustic_path * TYChemin::get_ray ( OPoint3D ptR )

Definition at line 159 of file TYChemin.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAttenuation() [1/2]

OSpectreComplex & TYChemin::getAttenuation ( )

inline

Return the path attenuation.

const OSpectreComplex& getAttenuation()

Returns: _attenuation

Definition at line 77 of file TYChemin.h.

◆ getAttenuation() [2/2]

const OSpectreComplex& TYChemin::getAttenuation ( ) const

inline

Definition at line 78 of file TYChemin.h.

◆ getDistance() [1/2]

double TYChemin::getDistance ( )

inline

Get/Set the distance between source and receptor.

const double getDistance() void setDistance(const double & distance)

Returns: _distance

Definition at line 105 of file TYChemin.h.

◆ getDistance() [2/2]

const double TYChemin::getDistance ( ) const

inline

Definition at line 106 of file TYChemin.h.

◆ getLongueur() [1/2]

double TYChemin::getLongueur ( )

inline

Get/Set the path length.

const double getLongueur() void setLongueur(const double & longueur)

Returns: _longueur

Definition at line 92 of file TYChemin.h.

◆ getLongueur() [2/2]

const double TYChemin::getLongueur ( ) const

inline

Definition at line 93 of file TYChemin.h.

◆ getType()

constint TYChemin::getType ( ) const

inline

Return the path type.

Returns: _typeChemin

Definition at line 121 of file TYChemin.h.

Here is the call graph for this function:

◆ operator!=()

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

Operator !=.

Definition at line 67 of file TYChemin.cpp.

Here is the call graph for this function:

◆ operator=()

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

Operator =.

Definition at line 39 of file TYChemin.cpp.

◆ operator==()

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

Operator ==.

Definition at line 53 of file TYChemin.cpp.

Here is the caller graph for this function:

◆ setAttenuation()

void TYChemin::setAttenuation ( const OSpectreComplex & att )

inline

Set the attenuation.

Definition at line 84 of file TYChemin.h.

◆ setDistance()

void TYChemin::setDistance ( const double & distance )

inline

Definition at line 108 of file TYChemin.h.

Here is the caller graph for this function:

◆ setLongueur()

void TYChemin::setLongueur ( const double & longueur )

inline

Definition at line 95 of file TYChemin.h.

Here is the caller graph for this function:

◆ setType()

void TYChemin::setType ( const int & type )

inline

Change the path type.

Definition at line 114 of file TYChemin.h.

Here is the caller graph for this function:

Member Data Documentation

◆ _attenuation

OSpectreComplex TYChemin::_attenuation

protected

Attenuation spectrum of the path.

Definition at line 141 of file TYChemin.h.

◆ _distance

double TYChemin::_distance

protected

Direct distance between source and receptor.

Definition at line 138 of file TYChemin.h.

◆ _eq_path

acoustic_path* TYChemin::_eq_path

protected

Equivalent acoustic_path.

Definition at line 144 of file TYChemin.h.

◆ _longueur

double TYChemin::_longueur

protected

Total path length.

Definition at line 135 of file TYChemin.h.

◆ _typeChemin

TYTypeChemin TYChemin::_typeChemin

protected

Path type (has an influence on the algorithm)

Definition at line 132 of file TYChemin.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/solvers/DefaultSolver/TYChemin.h
/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/solvers/DefaultSolver/TYChemin.cpp

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ TYChemin() [1/2]

◆ TYChemin() [2/2]

◆ ~TYChemin()

Member Function Documentation

◆ build_eq_path()

◆ calcAttenuation()

◆ get_ray()

◆ getAttenuation() [1/2]

◆ getAttenuation() [2/2]

◆ getDistance() [1/2]

◆ getDistance() [2/2]

◆ getLongueur() [1/2]

◆ getLongueur() [2/2]

◆ getType()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setAttenuation()

◆ setDistance()

◆ setLongueur()

◆ setType()

Member Data Documentation

◆ _attenuation

◆ _distance

◆ _eq_path

◆ _longueur

◆ _typeChemin