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>

Inheritance diagram for TYEtape:

Collaboration diagram for TYEtape:

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)
acoustic_event *	asEvent () const

Public Attributes
ACOUSTIC_EVENT_TYPES	_type
	Acoustic event type. More...
OPoint3D	_pt
	The starting point of this step. 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 44 of file TYEtape.h.

Constructor & Destructor Documentation

TYEtape() [1/2]

TYEtape::TYEtape

(

)

Constructor.

Definition at line 18 of file TYEtape.cpp.

TYEtape() [2/2]

TYEtape::TYEtape

(

const TYEtape &

other

)

Copy constructor.

Definition at line 20 of file TYEtape.cpp.

~TYEtape()

TYEtape::~TYEtape ( )

virtual

Destructor.

Definition at line 25 of file TYEtape.cpp.

Member Function Documentation

asEvent()

acoustic_event * TYEtape::asEvent

(

)

const

Definition at line 68 of file TYEtape.cpp.

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

operator!=()

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=()

TYEtape & TYEtape::operator=

(

const TYEtape &

other

)

Operator =.

Definition at line 27 of file TYEtape.cpp.

Here is the caller graph for this function:

operator==()

bool TYEtape::operator==

(

const TYEtape &

other

)

const

Operator ==.

Definition at line 39 of file TYEtape.cpp.

Here is the caller graph for this function:

setPoint()

void TYEtape::setPoint ( const OPoint3D &  pt )

inline

Definition at line 99 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 84 of file TYEtape.h.

Member Data Documentation

_pt

OPoint3D TYEtape::_pt

The starting point of this step.

Definition at line 109 of file TYEtape.h.

_type

ACOUSTIC_EVENT_TYPES TYEtape::_type

Acoustic event type.

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