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:

[legend]

Public Types
enum	EtapeType { EtapeInfra, EtapeTopo, EtapeForet }
	Indique le type de l'etape. 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
	Set/Get du type de cette etape. More...

void	setType (ACOUSTIC_EVENT_TYPES etapeType)

OPoint3D	getPoint () const
	Get/Set of the first point of the step. More...

void	setPoint (const OPoint3D &pt)

OSpectreComplex	getAbsorption ()
	Get/Set the absorption spectrum associated to the first point of the step. More...

const OSpectreComplex	getAbsorption () const

void	setAbsorption (const OSpectreComplex &Abso)

OSpectre	getAttenuation ()
	Get/Set the attenuation spectrum associated to this step. More...

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

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 47 of file TYEtape.h.

Member Enumeration Documentation

◆ EtapeType

enum enum TYEtape::EtapeType

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 58 of file TYEtape.h.

Constructor & Destructor Documentation

◆ TYEtape() [1/2]

TYEtape::TYEtape ( )

Constructor.

Definition at line 20 of file TYEtape.cpp.

◆ TYEtape() [2/2]

TYEtape::TYEtape ( const TYEtape & other )

Copy constructor.

Definition at line 24 of file TYEtape.cpp.

◆ ~TYEtape()

TYEtape::~TYEtape ( )

virtual

Destructor.

Definition at line 29 of file TYEtape.cpp.

Member Function Documentation

◆ asEvent()

acoustic_event * TYEtape::asEvent ( ) const

Definition at line 62 of file TYEtape.cpp.

Here is the caller graph for this function:

◆ getAbsorption() [1/2]

OSpectreComplex TYEtape::getAbsorption ( )

inline

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

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

Returns: _Absorption

Definition at line 117 of file TYEtape.h.

◆ getAbsorption() [2/2]

const OSpectreComplex TYEtape::getAbsorption ( ) const

inline

Definition at line 118 of file TYEtape.h.

◆ getAttenuation() [1/2]

OSpectre TYEtape::getAttenuation ( )

inline

Get/Set the attenuation spectrum associated to this step.

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

Returns: _Attenuation

Definition at line 131 of file TYEtape.h.

◆ getAttenuation() [2/2]

const OSpectre TYEtape::getAttenuation ( ) const

inline

Definition at line 132 of file TYEtape.h.

◆ getPoint()

OPoint3D TYEtape::getPoint ( ) const

inline

Get/Set of the first point of the step.

void setPoint(const OPoint3D & pt)

Returns: _pt

Definition at line 107 of file TYEtape.h.

◆ getType()

int TYEtape::getType ( ) const

inline

Set/Get du type de cette etape.

void setType(int etapeType)

Returns: _type: type de l'etape

Definition at line 95 of file TYEtape.h.

◆ operator!=()

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

Operator !=.

Definition at line 57 of file TYEtape.cpp.

Here is the call graph for this function:

◆ operator=()

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

Operator =.

Definition at line 33 of file TYEtape.cpp.

◆ operator==()

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

Operator ==.

Definition at line 45 of file TYEtape.cpp.

Here is the caller graph for this function:

◆ setAbsorption()

void TYEtape::setAbsorption ( const OSpectreComplex & Abso )

inline

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

Definition at line 122 of file TYEtape.h.

◆ setAttenuation()

void TYEtape::setAttenuation ( const OSpectre & Att )

inline

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

Definition at line 136 of file TYEtape.h.

Here is the call graph for this function:

◆ setPoint()

void TYEtape::setPoint ( const OPoint3D & pt )

inline

Definition at line 108 of file TYEtape.h.

Here is the caller graph for this function:

◆ setType()

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

OSpectreComplex TYEtape::_Absorption

absorption Spectrum

Definition at line 143 of file TYEtape.h.

◆ _Attenuation

OSpectre TYEtape::_Attenuation

attenuation Spectrum

Definition at line 144 of file TYEtape.h.

◆ _pt

OPoint3D TYEtape::_pt

The starting point of this step.

Definition at line 142 of file TYEtape.h.

◆ _type

ACOUSTIC_EVENT_TYPES TYEtape::_type

Acoustic event type.

Definition at line 141 of file TYEtape.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/TYEtape.h
/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/solvers/DefaultSolver/TYEtape.cpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Enumeration Documentation

◆ EtapeType

Constructor & Destructor Documentation

◆ TYEtape() [1/2]

◆ TYEtape() [2/2]

◆ ~TYEtape()

Member Function Documentation

◆ asEvent()

◆ getAbsorption() [1/2]

◆ getAbsorption() [2/2]

◆ getAttenuation() [1/2]

◆ getAttenuation() [2/2]

◆ getPoint()

◆ getType()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setAbsorption()

◆ setAttenuation()

◆ setPoint()

◆ setType()

Member Data Documentation

◆ _Absorption

◆ _Attenuation

◆ _pt

◆ _type