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

#include <TYChemin.h>

Inheritance diagram for TYChemin:

Collaboration diagram for TYChemin:

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

Definition at line 63 of file TYChemin.h.

Constructor & Destructor Documentation

TYChemin() [1/2]

TYChemin::TYChemin

(

)

Constructor.

Definition at line 19 of file TYChemin.cpp.

TYChemin() [2/2]

TYChemin::TYChemin

(

const TYChemin &

other

)

Copy contructor.

Definition at line 24 of file TYChemin.cpp.

~TYChemin()

TYChemin::~TYChemin ( )

virtual

Destructor.

Definition at line 29 of file TYChemin.cpp.

Here is the call graph for this function:

Member Function Documentation

build_eq_path()

template<typename T >

template< typename T > void TYChemin::build_eq_path ( const T &  tabEtapes )

inline

build an acoustic_path from the tab of etapes

Definition at line 156 of file TYChemin.h.

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 80 of file TYChemin.cpp.

Here is the call graph for this function:

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 119 of file TYChemin.h.

getDistance() [2/2]

const double TYChemin::getDistance ( ) const

inline

Definition at line 123 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 97 of file TYChemin.h.

Here is the caller graph for this function:

getLongueur() [2/2]

const double TYChemin::getLongueur ( ) const

inline

Definition at line 101 of file TYChemin.h.

getType()

const TYTypeChemin TYChemin::getType ( ) const

inline

Return the path type.

Returns

_typeChemin

Definition at line 147 of file TYChemin.h.

Here is the caller graph for this function:

operator!=()

bool TYChemin::operator!=

(

const TYChemin &

other

)

const

Operator !=.

Definition at line 75 of file TYChemin.cpp.

Here is the call graph for this function:

operator=()

TYChemin & TYChemin::operator=

(

const TYChemin &

other

)

Operator =.

Definition at line 37 of file TYChemin.cpp.

Here is the caller graph for this function:

operator==()

bool TYChemin::operator==

(

const TYChemin &

other

)

const

Operator ==.

Definition at line 50 of file TYChemin.cpp.

Here is the caller graph for this function:

setDistance()

void TYChemin::setDistance ( const double &  distance )

inline

Definition at line 128 of file TYChemin.h.

Here is the caller graph for this function:

setLongueur()

void TYChemin::setLongueur ( const double &  longueur )

inline

Definition at line 106 of file TYChemin.h.

Here is the caller graph for this function:

setType()

void TYChemin::setType ( const TYTypeChemin &  type )

inline

Change the path type.

Definition at line 137 of file TYChemin.h.

Here is the caller graph for this function:

Member Data Documentation

_distance

double TYChemin::_distance

protected

Direct distance between source and receptor.

Definition at line 174 of file TYChemin.h.

_eq_path

acoustic_path* TYChemin::_eq_path

protected

Equivalent acoustic_path.

Definition at line 177 of file TYChemin.h.

_longueur

double TYChemin::_longueur

protected

Total path length.

Definition at line 171 of file TYChemin.h.

_typeChemin

TYTypeChemin TYChemin::_typeChemin

protected

Path type (has an influence on the algorithm)

Definition at line 168 of file TYChemin.h.

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_647/Tympan/solvers/9613/TYChemin.h
• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan/checkouts/issue_647/Tympan/solvers/9613/TYChemin.cpp