TYEtape Class Reference

The TYEtape class is used to describe a part (a step) of a path (TYChemin) for the computation of trajectories (TYTrajet) between Source and receptor (Recepteur) More...

#include <TYEtape.h>

Collaboration diagram for TYEtape:

Public Types
enum	EtapeType { EtapeInfra , EtapeTopo , EtapeForet }
	EtapeType : Indique le type de l'etape. EtapeType::EtapeInfra : Reflexion sur un element d'infrastructure. EtapeType::EtapeTopo : Reflexion sur un element de topographie (sol). EtapeType::EtapeForet : Changement de milieu (on entre ou on sort d'une foret). More...

Public Member Functions
	TYEtape ()
	Constructor. More...
	TYEtape (const TYEtape &other)
	Copy constructor. More...
virtual	~TYEtape ()
	Destructor. More...
TYEtape &	operator= (const TYEtape &other)
	Operator =. More...
bool	operator== (const TYEtape &other) const
	Operator ==. More...
bool	operator!= (const TYEtape &other) const
	Operator !=. More...
ACOUSTIC_EVENT_TYPES	getType () const
void	setType (ACOUSTIC_EVENT_TYPES etapeType)
OPoint3D	getPoint () const
void	setPoint (const OPoint3D &pt)
OSpectreOctave	getAbsorption ()
	Get/Set the absorption spectrum associated to the first point of the step. More...
const OSpectreOctave	getAbsorption () const
void	setAbsorption (const OSpectreOctave &Abso)
OSpectreOctave	getAttenuation ()
	Get/Set the attenuation spectrum associated to this step. More...
const OSpectreOctave	getAttenuation () const
void	setAttenuation (const OSpectreOctave &Att)
acoustic_event *	asEvent () const
double	getG ()
const double	getG () const
void	setG (double G)
	TYEtape ()
	TYEtape (const TYEtape &other)
virtual	~TYEtape ()
TYEtape &	operator= (const TYEtape &other)
	Operator =. More...
bool	operator== (const TYEtape &other) const
	Operator ==. More...
bool	operator!= (const TYEtape &other) const
	Operator !=. More...
ACOUSTIC_EVENT_TYPES	getType () const
void	setType (ACOUSTIC_EVENT_TYPES etapeType)
OPoint3D	getPoint () const
void	setPoint (const OPoint3D &pt)
OSpectreComplex	getAbsorption ()
const OSpectreComplex	getAbsorption () const
void	setAbsorption (const OSpectreComplex &Abso)
OSpectre	getAttenuation ()
const OSpectre	getAttenuation () const
void	setAttenuation (const OSpectre &Att)
acoustic_event *	asEvent () const

Public Attributes
ACOUSTIC_EVENT_TYPES	_type
	Acoustic event type. More...
OPoint3D	_pt
	The starting point of this step. More...
OSpectreOctave	_Absorption
	absorption Spectrum More...
OSpectreOctave	_Attenuation
	attenuation Spectrum More...
double	_G
	ground factor More...
OSpectreComplex	_Absorption
	absorption Spectrum More...
OSpectre	_Attenuation
	attenuation Spectrum More...

Detailed Description

The TYEtape class is used to describe a part (a step) of a path (TYChemin) for the computation of trajectories (TYTrajet) between Source and receptor (Recepteur)

Date

2008/01/21

Version

v 1.1

Author

Projet_Tympan To a first point of the step is associated an absorption (this one is significant for the first point of the path, which is associated to a source, a directivity and a ground reflection point). A attenuation is also associated, depending of the step length. It is related to the encountered medium (atmosphere, forest, ...).

Definition at line 46 of file TYEtape.h.

Member Enumeration Documentation

EtapeType

enum enum TYEtape::EtapeType

EtapeType : Indique le type de l'etape. EtapeType::EtapeInfra : Reflexion sur un element d'infrastructure. EtapeType::EtapeTopo : Reflexion sur un element de topographie (sol). EtapeType::EtapeForet : Changement de milieu (on entre ou on sort d'une foret).

Indique le type de l'etape.

Parameters

EtapeInfra:Reflexion

sur un element d'infrastructure. EtapeTopo: Reflexion sur un element de topographie (sol). EtapeForet:Changement de milieu (on entre ou on sort d'une foret).

Enumerator
EtapeInfra
EtapeTopo
EtapeForet

Definition at line 56 of file TYEtape.h.

Constructor & Destructor Documentation

TYEtape() [1/4]

TYEtape::TYEtape

(

)

Constructor.

Definition at line 18 of file TYEtape.cpp.

TYEtape() [2/4]

TYEtape::TYEtape

(

const TYEtape &

other

)

Copy constructor.

Definition at line 20 of file TYEtape.cpp.

~TYEtape() [1/2]

TYEtape::~TYEtape ( )

virtual

Destructor.

Definition at line 25 of file TYEtape.cpp.

TYEtape() [3/4]

TYEtape::TYEtape

(

)

TYEtape() [4/4]

TYEtape::TYEtape

(

const TYEtape &

other

)

~TYEtape() [2/2]

virtual TYEtape::~TYEtape ( )

virtual

Member Function Documentation

asEvent() [1/2]

acoustic_event * TYEtape::asEvent

(

)

const

Definition at line 68 of file TYEtape.cpp.

asEvent() [2/2]

acoustic_event* TYEtape::asEvent

(

)

const

getAbsorption() [1/4]

OSpectreComplex TYEtape::getAbsorption ( )

inline

Get/Set the absorption spectrum associated to the first point of the step.

const OSpectreOctave getAbsorption() void setAbsorption(const OSpectreOctave & Abso)

Returns

_Absorption

const OSpectreComplex getAbsorption() void setAbsorption(const OSpectreComplex & Abso)

Returns

_Absorption

Definition at line 128 of file TYEtape.h.

getAbsorption() [2/4]

OSpectreComplex TYEtape::getAbsorption ( )

inline

Definition at line 126 of file TYEtape.h.

getAbsorption() [3/4]

const OSpectreOctave TYEtape::getAbsorption ( ) const

inline

Definition at line 132 of file TYEtape.h.

getAbsorption() [4/4]

const OSpectreComplex TYEtape::getAbsorption ( ) const

inline

Definition at line 130 of file TYEtape.h.

getAttenuation() [1/4]

OSpectre TYEtape::getAttenuation ( )

inline

Get/Set the attenuation spectrum associated to this step.

const OSpectreOctave getAttenuation() void setAttenuation(const OSpectreOctave & Att)

Returns

_Attenuation

const OSpectre getAttenuation() void setAttenuation(const OSpectre & Att)

Returns

_Attenuation

Definition at line 151 of file TYEtape.h.

getAttenuation() [2/4]

OSpectre TYEtape::getAttenuation ( )

inline

Definition at line 149 of file TYEtape.h.

getAttenuation() [3/4]

const OSpectreOctave TYEtape::getAttenuation ( ) const

inline

Definition at line 155 of file TYEtape.h.

getAttenuation() [4/4]

const OSpectre TYEtape::getAttenuation ( ) const

inline

Definition at line 153 of file TYEtape.h.

getG() [1/2]

double TYEtape::getG ( )

inline

Definition at line 168 of file TYEtape.h.

getG() [2/2]

const double TYEtape::getG ( ) const

inline

Definition at line 173 of file TYEtape.h.

getPoint() [1/2]

OPoint3D TYEtape::getPoint ( ) const

inline

Definition at line 112 of file TYEtape.h.

getPoint() [2/2]

OPoint3D TYEtape::getPoint ( ) const

inline

Definition at line 110 of file TYEtape.h.

getType() [1/2]

ACOUSTIC_EVENT_TYPES TYEtape::getType ( ) const

inline

Definition at line 94 of file TYEtape.h.

getType() [2/2]

ACOUSTIC_EVENT_TYPES TYEtape::getType ( ) const

inline

Definition at line 92 of file TYEtape.h.

operator!=() [1/2]

bool TYEtape::operator!=

(

const TYEtape &

other

)

const

Operator !=.

Definition at line 63 of file TYEtape.cpp.

Here is the call graph for this function:

operator!=() [2/2]

bool TYEtape::operator!=

(

const TYEtape &

other

)

const

Operator !=.

operator=() [1/2]

TYEtape & TYEtape::operator=

(

const TYEtape &

other

)

Operator =.

Definition at line 27 of file TYEtape.cpp.

operator=() [2/2]

TYEtape& TYEtape::operator=

(

const TYEtape &

other

)

Operator =.

operator==() [1/2]

bool TYEtape::operator==

(

const TYEtape &

other

)

const

Operator ==.

Definition at line 39 of file TYEtape.cpp.

Here is the caller graph for this function:

operator==() [2/2]

bool TYEtape::operator==

(

const TYEtape &

other

)

const

Operator ==.

setAbsorption() [1/2]

void TYEtape::setAbsorption ( const OSpectreComplex &  Abso )

inline

Set/Get du spectre d'absorption associe au point de depart.

Definition at line 137 of file TYEtape.h.

setAbsorption() [2/2]

void TYEtape::setAbsorption ( const OSpectreOctave &  Abso )

inline

Set/Get du spectre d'absorption associe au point de depart.

Definition at line 139 of file TYEtape.h.

setAttenuation() [1/2]

void TYEtape::setAttenuation ( const OSpectre &  Att )

inline

Set/Get du spectre d'attenuation associe a cette etape.

Definition at line 160 of file TYEtape.h.

setAttenuation() [2/2]

void TYEtape::setAttenuation ( const OSpectreOctave &  Att )

inline

Set/Get du spectre d'attenuation associe a cette etape.

Definition at line 162 of file TYEtape.h.

setG()

void TYEtape::setG ( double  G )

inline

Definition at line 178 of file TYEtape.h.

setPoint() [1/2]

void TYEtape::setPoint ( const OPoint3D &  pt )

inline

Definition at line 116 of file TYEtape.h.

Here is the caller graph for this function:

setPoint() [2/2]

void TYEtape::setPoint ( const OPoint3D &  pt )

inline

Definition at line 114 of file TYEtape.h.

setType() [1/2]

void TYEtape::setType ( ACOUSTIC_EVENT_TYPES  etapeType )

inline

Set/Get du type de cette etape.

Definition at line 101 of file TYEtape.h.

setType() [2/2]

void TYEtape::setType ( ACOUSTIC_EVENT_TYPES  etapeType )

inline

Set/Get du type de cette etape.

Definition at line 99 of file TYEtape.h.

Member Data Documentation

_Absorption [1/2]

OSpectreOctave TYEtape::_Absorption

absorption Spectrum

Definition at line 187 of file TYEtape.h.

_Absorption [2/2]

OSpectreComplex TYEtape::_Absorption

absorption Spectrum

Definition at line 170 of file TYEtape.h.

_Attenuation [1/2]

OSpectreOctave TYEtape::_Attenuation

attenuation Spectrum

Definition at line 188 of file TYEtape.h.

_Attenuation [2/2]

OSpectre TYEtape::_Attenuation

attenuation Spectrum

Definition at line 171 of file TYEtape.h.

_G

double TYEtape::_G

ground factor

Definition at line 189 of file TYEtape.h.

_pt

OPoint3D TYEtape::_pt

The starting point of this step.

Definition at line 186 of file TYEtape.h.

_type

ACOUSTIC_EVENT_TYPES TYEtape::_type

Acoustic event type.

Definition at line 185 of file TYEtape.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/solvers/9613Solver/TYEtape.h
• /home/docs/checkouts/readthedocs.org/user_builds/code-tympan-fbessou/checkouts/latest/Tympan/solvers/9613Solver/TYEtape.cpp