TYTrajet Class Reference

This class TYTrajet (journey) links a couple Source-Receptor and a collection of paths, in addition to the direct path. More...

#include <TYTrajet.h>

Inheritance diagram for TYTrajet:

Collaboration diagram for TYTrajet:

Public Member Functions
	TYTrajet (tympan::AcousticSource &asrc_, tympan::AcousticReceptor &arcpt_)
	Constructor. More...
	TYTrajet (const TYTrajet &other)
	Copy constructor. More...
virtual	~TYTrajet ()
	Destructor. More...
TYTrajet &	operator= (const TYTrajet &other)
	Operator =. More...
bool	operator== (const TYTrajet &other) const
	Operator ==. More...
bool	operator!= (const TYTrajet &other) const
	Operator !=. More...
virtual void	reset ()=0
	Reset method. More...
double	getDistance ()
	Get/Set the distance between source and receptor. More...
const double	getDistance () const
void	setDistance (const double &distance)
void	setPtSetPtR (const OPoint3D &pt1, const OPoint3D &pt2)
	Get/Set points for source and receptor. More...
void	getPtSetPtR (OPoint3D &pt1, OPoint3D &pt2)
void	setPtSetPtRfromOSeg3D (const OSegment3D &seg)
	Get/Set points for source and receptor with an OSegment3D. More...
void	getPtSetPtRfromOSeg3D (OSegment3D &seg) const
std::vector< acoustic_path * > &	get_tab_rays ()

Public Attributes
tympan::AcousticSource &	asrc
	Business source. More...
tympan::source_idx	asrc_idx
tympan::AcousticReceptor &	arcpt
	Business receptor. More...
tympan::receptor_idx	arcpt_idx

Protected Attributes
OPoint3D	_ptS
	Source point definition in the site frame. More...
OPoint3D	_ptR
	Receptor point definition in the site frame. More...
double	_distance
	Distance between source and receptor. More...
std::vector< acoustic_path * >	_tabRays
	Vector of rays equivalent to chemin. More...

Detailed Description

This class TYTrajet (journey) links a couple Source-Receptor and a collection of paths, in addition to the direct path.

Version

v 2.0

Date

2024/01/17

Author

Projet_Tympan

Definition at line 32 of file TYTrajet.h.

Constructor & Destructor Documentation

TYTrajet() [1/2]

TYTrajet::TYTrajet	(	tympan::AcousticSource &	asrc_,
		tympan::AcousticReceptor &	arcpt_
	)

Constructor.

Parameters

asrc_	Source
arcpt_	Receptor

Definition at line 19 of file TYTrajet.cpp.

Here is the call graph for this function:

TYTrajet() [2/2]

TYTrajet::TYTrajet

(

const TYTrajet &

other

)

Copy constructor.

Definition at line 27 of file TYTrajet.cpp.

Here is the call graph for this function:

~TYTrajet()

TYTrajet::~TYTrajet ( )

virtual

Destructor.

Definition at line 41 of file TYTrajet.cpp.

Member Function Documentation

get_tab_rays()

std::vector< acoustic_path * > & TYTrajet::get_tab_rays

(

)

Definition at line 94 of file TYTrajet.cpp.

getDistance() [1/2]

double TYTrajet::getDistance ( )

inline

Get/Set the distance between source and receptor.

const double getDistance()

Returns

_distance

Definition at line 75 of file TYTrajet.h.

Here is the caller graph for this function:

getDistance() [2/2]

const double TYTrajet::getDistance ( ) const

inline

Definition at line 79 of file TYTrajet.h.

getPtSetPtR()

void TYTrajet::getPtSetPtR ( OPoint3D &  pt1, OPoint3D &  pt2  )

inline

Definition at line 99 of file TYTrajet.h.

getPtSetPtRfromOSeg3D()

void TYTrajet::getPtSetPtRfromOSeg3D ( OSegment3D &  seg ) const

inline

Definition at line 115 of file TYTrajet.h.

Here is the caller graph for this function:

operator!=()

bool TYTrajet::operator!=

(

const TYTrajet &

other

)

const

Operator !=.

Definition at line 89 of file TYTrajet.cpp.

Here is the call graph for this function:

operator=()

TYTrajet & TYTrajet::operator=

(

const TYTrajet &

other

)

Operator =.

Definition at line 43 of file TYTrajet.cpp.

Here is the caller graph for this function:

operator==()

bool TYTrajet::operator==

(

const TYTrajet &

other

)

const

Operator ==.

Definition at line 58 of file TYTrajet.cpp.

Here is the caller graph for this function:

reset()

void TYTrajet::reset ( void  )

pure virtual

Reset method.

Implemented in TYTrajetDefaultSolver, and TYTrajet9613Solver.

setDistance()

void TYTrajet::setDistance ( const double &  distance )

inline

Definition at line 84 of file TYTrajet.h.

setPtSetPtR()

void TYTrajet::setPtSetPtR ( const OPoint3D &  pt1, const OPoint3D &  pt2  )

inline

Get/Set points for source and receptor.

void getPtSetPtR(OPoint3D& pt1, OPoint3D& pt2)

Definition at line 94 of file TYTrajet.h.

setPtSetPtRfromOSeg3D()

void TYTrajet::setPtSetPtRfromOSeg3D ( const OSegment3D &  seg )

inline

Get/Set points for source and receptor with an OSegment3D.

void getPtSetPtRfromOSeg3D(OSegment3D& seg)

Definition at line 110 of file TYTrajet.h.

Member Data Documentation

_distance

double TYTrajet::_distance

protected

Distance between source and receptor.

Definition at line 142 of file TYTrajet.h.

_ptR

OPoint3D TYTrajet::_ptR

protected

Receptor point definition in the site frame.

Definition at line 139 of file TYTrajet.h.

_ptS

OPoint3D TYTrajet::_ptS

protected

Source point definition in the site frame.

Definition at line 136 of file TYTrajet.h.

_tabRays

std::vector<acoustic_path*> TYTrajet::_tabRays

protected

Vector of rays equivalent to chemin.

Definition at line 145 of file TYTrajet.h.

arcpt

tympan::AcousticReceptor& TYTrajet::arcpt

Business receptor.

Definition at line 130 of file TYTrajet.h.

arcpt_idx

tympan::receptor_idx TYTrajet::arcpt_idx

Definition at line 131 of file TYTrajet.h.

asrc

tympan::AcousticSource& TYTrajet::asrc

Business source.

Definition at line 126 of file TYTrajet.h.

asrc_idx

tympan::source_idx TYTrajet::asrc_idx

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