#include <TYPlanEau.h>

Inheritance diagram for TYPlanEau:

Collaboration diagram for TYPlanEau:

Public Member Functions
	TYPlanEau ()

	TYPlanEau (const TYPlanEau &other)

	TYPlanEau (const TYTabPoint &pts, double alt)

virtual	~TYPlanEau ()

TYPlanEau &	operator= (const TYPlanEau &other)
	Operateur =. More...

bool	operator== (const TYPlanEau &other) const
	Operateur ==. More...

bool	operator!= (const TYPlanEau &other) const
	Operateur !=. More...

virtual bool	deepCopy (const TYElement *pOther, bool copyId=true, bool pUseCopyTag=false)

virtual std::string	toString () const

virtual DOM_Element	toXML (DOM_Element &domElement)

virtual int	fromXML (DOM_Element domElement)

virtual void	setIsGeometryModified (bool isModified)

LPTYCourbeNiveau	getCrbNiv ()

void	setCrbNiv (LPTYCourbeNiveau pCrbNiv)

double	getAltitude () const

void	setAltitude (double alt)

virtual TYTabPoint &	getListPoints ()

virtual const TYTabPoint &	getListPoints () const

virtual void	setListPoints (const TYTabPoint &liste)

void	setDistMax (const double dist)

double	getDistMax ()

const double	getDistMax () const

bool	getIsDMaxDefault ()

const bool	getIsDMaxDefault () const

void	setIsDMaxDefault (const bool &etat)

void	updateDistMax ()

void	offsetListPoints ()

Public Member Functions inherited from TYTerrain
	TYTerrain ()

	TYTerrain (const TYTerrain &other)

virtual	~TYTerrain ()

TYTerrain &	operator= (const TYTerrain &other)
	Operateur =. More...

bool	operator== (const TYTerrain &other) const
	Operateur ==. More...

bool	operator!= (const TYTerrain &other) const
	Operateur !=. More...

LPTYSol	getSol () const

LPTYSol	getSol ()

void	setSol (const LPTYSol pSol)

bool	isVegetActive ()

LPTYVegetation	getVegetation () const

void	setVegetation (LPTYVegetation pVeget)

void	useVegetation (bool state=true)

bool	isUsingVegetation ()

double	surface ()

void	offsetListPoints ()

Public Member Functions inherited from TYElement
void *	getAllUses ()

void	setAllUses (void *allUses)

void	cleanAllUses ()

	TYElement ()

	TYElement (TYElement *pParent, bool PutInInstanceList=true)

	TYElement (const TYElement &other, bool PutInInstanceList=true)

virtual	~TYElement ()

void	setID (TYUUID id)

void	setID (const QString &str_id)

const TYUUID &	getID () const

QString	getStringID () const

bool	hasNullID () const

void	regenerateID ()

void	setName (QString name)

void	setName (std::string name)

virtual QString	getName () const

void	setParent (TYElement *pParent)

TYElement *	getParent () const

virtual void	setIsAcousticModified (bool isModified)

bool	getIsAcousticModified ()

bool	getIsGeometryModified ()

TYElement &	operator= (const TYElement &other)

bool	operator== (const TYElement &other) const

bool	operator!= (const TYElement &other) const

bool	callFromXMLIfEqual (DOM_Element &domElement, int *pRetVal=NULL)

std::string	getMetierName ()

virtual void	updateCurrentCalcul (TYListID &listID, bool recursif=true)

virtual void	getChilds (LPTYElementArray &childs, bool recursif=true)

virtual void	setInCurrentCalcul (bool state, bool recurschild=true, bool recursparent=true)

virtual bool	isInCurrentCalcul ()

void	addCopy ()
	Increment le compteur de nombre de copies. More...

void	setCopyCount (const unsigned int copyCount)
	Modifie la vaeur du compteur. More...

Public Member Functions inherited from IRefCount
	IRefCount ()

virtual	~IRefCount ()

virtual int	incRef ()

virtual int	decRef ()

int	getRefCount () const

Public Member Functions inherited from OPrototype
virtual	~OPrototype ()

virtual OPrototype *	clone () const =0

virtual const char *	getClassName () const

bool	isA (const char *className) const

Public Member Functions inherited from TYColorInterface
virtual void	updateColor ()

	TYColorInterface ()

	TYColorInterface (const TYColorInterface &other)

virtual	~TYColorInterface ()

TYColorInterface &	operator= (const TYColorInterface &other)

bool	operator== (const TYColorInterface &other) const

bool	operator!= (const TYColorInterface &other) const

void	deepCopy (const TYColorInterface *pOther, bool copyId=true, bool pUseCopyTag=false)

DOM_Element	toXML (DOM_Element &domElement)

int	fromXML (DOM_Element domElement)

virtual void	setColor (const OColor &color)

OColor	getColor () const

Protected Attributes
LPTYCourbeNiveau	_pCrbNiv
	Une courbe de niveau correspondant a ce plan d'eau. More...

Protected Attributes inherited from TYTerrain
LPTYSol	_pSol
	Materiau. More...

LPTYVegetation	_pVegetation
	Vegetation eventuelle. More...

bool	_vegetActive
	Etat d'utilisation de la vegetation. More...

TYTabPoint	_listPoints
	Liste de points. More...

Protected Attributes inherited from TYElement
QString	_name
	Nom courant de l'element. More...

TYElement *	_pParent
	Reference sur l'element parent. More...

bool	_bPutInInstanceList

unsigned int	_copyCount

bool	_inCurrentCalcul
	Indique si cet element est actif dans le Calcul courant. More...

bool	_isAcousticModified
	Indicateur de modification acoustique. More...

bool	_isGeometryModified
	Indicateur de modification de la geometrie. More...

LPTYElementGraphic	_pGraphicObject
	L'object graphique metier associe a cet element. More...

void *	_allUses
	Multi purpose void pointer (use for compatibility actually) More...

Protected Attributes inherited from IRefCount
int	m_refCount
	The reference counter. More...

Protected Attributes inherited from TYColorInterface
OColor	_color

Additional Inherited Members
Static Public Member Functions inherited from TYElement
static LPTYElementArray	findTypeCollectionAndCallFromXML (DOM_Element parentElem, const char *type)

static void	setLogInstances (bool log)

static bool	getLogInstances ()

static TYElement *	getInstance (TYUUID uuid)

static void	purgeInstances ()

static bool	testId (const TYUUID &id, const TYElement *pElem)

static TYUUID	newID ()

static TYUUID	fromString (QString id)

static QString	toString (TYUUID &uuid)

static uint64	getConstructorCount ()

static uint64	getDestructorCount ()

static uint64	getIdGenerationCount ()

static bool	getIsSavedOk ()

static void	setIsSavedOk (const bool &toSave)

static void	setRegenerateID (const bool &bRegenerate)

static bool	getRegenerateID ()

Static Public Member Functions inherited from OPrototype
static OPrototype *	findAndClone (const char *className)

static int	findPrototype (const char *className)

static OPrototype *	safeDownCast (OPrototype *pObject)

static void	add_factory (const char *, IOProtoFactory::ptr_type factory)

Protected Member Functions inherited from OPrototype
	OPrototype ()

Detailed Description

Classe pour la representation d'un plan eau. Un plan d'eau est un terrain particulier, chaque points constituant la delimitation ont a meme altitude. Les plans d'eau sont pris en compte pour la generation de l'altimetrie.

Definition at line 34 of file TYPlanEau.h.

Constructor & Destructor Documentation

◆ TYPlanEau() [1/3]

TYPlanEau::TYPlanEau ( )

Constructeur.

Definition at line 31 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ TYPlanEau() [2/3]

TYPlanEau::TYPlanEau ( const TYPlanEau & other )

Constructeur par copie.

Definition at line 58 of file TYPlanEau.cpp.

◆ TYPlanEau() [3/3]

TYPlanEau::TYPlanEau	(	const TYTabPoint &	pts,
		double	alt
	)

Constructeur.

Definition at line 63 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ ~TYPlanEau()

TYPlanEau::~TYPlanEau ( )

virtual

Destructeur.

Definition at line 70 of file TYPlanEau.cpp.

Member Function Documentation

◆ deepCopy()

bool TYPlanEau::deepCopy	(	const TYElement *	pOther,
		bool	copyId = `true`,
		bool	pUseCopyTag = `false`
	)

virtual

Effectue une copie en allouant de la memoire (deep copy) et non pas en copiant seulement les pointeurs (shallow copy). Cette methode s'utilise comme l'operateur egal. L'ID peut ne pas etre copie, le parent n'est jamais copie.

Parameters

pOther	L'element a copier.
copyId	Copie l'identifiant unique ou pas.

Returns: true si la copie est possible; false sinon.

Reimplemented from TYTerrain.

Definition at line 99 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ fromXML()

int TYPlanEau::fromXML ( DOM_Element domElement )

virtual

Extrait les informations a partir du noeud DOM passe afin de recuperer les parametres de la classe.

Parameters

domElement Le noeud DOM a partir duquel les parametres doivent etre recuperes.

Returns: 1 si la recuperation des parametres a reussie.

Reimplemented from TYTerrain.

Definition at line 124 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ getAltitude()

double TYPlanEau::getAltitude ( ) const

inline

Set/Get de l'_altitude.

Definition at line 93 of file TYPlanEau.h.

Here is the call graph for this function:

◆ getCrbNiv()

LPTYCourbeNiveau TYPlanEau::getCrbNiv ( )

inline

Set/Get de la courbe de niveau associee a ce plan d'eau.

Definition at line 78 of file TYPlanEau.h.

◆ getDistMax() [1/2]

double TYPlanEau::getDistMax ( )

inline

Get/Set de la distance minimale entre deux points

Definition at line 120 of file TYPlanEau.h.

Here is the call graph for this function:

◆ getDistMax() [2/2]

const double TYPlanEau::getDistMax ( ) const

inline

Definition at line 121 of file TYPlanEau.h.

Here is the call graph for this function:

◆ getIsDMaxDefault() [1/2]

bool TYPlanEau::getIsDMaxDefault ( )

inline

Get/Set de l'etat de la valeur distance min

Definition at line 126 of file TYPlanEau.h.

Here is the call graph for this function:

◆ getIsDMaxDefault() [2/2]

const bool TYPlanEau::getIsDMaxDefault ( ) const

inline

Definition at line 127 of file TYPlanEau.h.

Here is the call graph for this function:

◆ getListPoints() [1/2]

virtual TYTabPoint& TYPlanEau::getListPoints ( )

inlinevirtual

Set/Get de la liste de points.

Reimplemented from TYTerrain.

Definition at line 102 of file TYPlanEau.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getListPoints() [2/2]

virtual const TYTabPoint& TYPlanEau::getListPoints ( ) const

inlinevirtual

Set/Get de la liste de points.

Reimplemented from TYTerrain.

Definition at line 106 of file TYPlanEau.h.

Here is the call graph for this function:

◆ offsetListPoints()

void TYPlanEau::offsetListPoints ( )

Offset la liste de points lors de la duplication

Definition at line 149 of file TYPlanEau.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator!=()

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

Operateur !=.

Definition at line 94 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ operator=()

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

Operateur =.

Definition at line 74 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ operator==()

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

Operateur ==.

Definition at line 84 of file TYPlanEau.cpp.

Here is the caller graph for this function:

◆ setAltitude()

void TYPlanEau::setAltitude ( double alt )

inline

Set/Get de l'_altitude.

Definition at line 97 of file TYPlanEau.h.

Here is the call graph for this function:

◆ setCrbNiv()

void TYPlanEau::setCrbNiv ( LPTYCourbeNiveau pCrbNiv )

inline

Set/Get de la courbe de niveau associee a ce plan d'eau.

Definition at line 83 of file TYPlanEau.h.

Here is the call graph for this function:

◆ setDistMax()

void TYPlanEau::setDistMax ( const double dist )

inline

Set/Get de la distance minimale entre les points pour la triangulation de Delaunay

Definition at line 115 of file TYPlanEau.h.

Here is the call graph for this function:

◆ setIsDMaxDefault()

void TYPlanEau::setIsDMaxDefault ( const bool & etat )

inline

Get/Set de l'etat de la valeur distance min par defaut

Definition at line 132 of file TYPlanEau.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsGeometryModified()

void TYPlanEau::setIsGeometryModified ( bool isModified )

virtual

Set/Get de l'indicateur de modification de la geometrie.

Reimplemented from TYElement.

Definition at line 142 of file TYPlanEau.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setListPoints()

virtual void TYPlanEau::setListPoints ( const TYTabPoint & liste )

inlinevirtual

Set/Get de la liste de points.

Reimplemented from TYTerrain.

Definition at line 110 of file TYPlanEau.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

std::string TYPlanEau::toString ( ) const

virtual

Retourne une chaine de caractere donnant des informations sur cet objet (utile pour le debugage).

Returns: Une chaine de caractere informative sur cet objet.

Reimplemented from TYTerrain.

Definition at line 110 of file TYPlanEau.cpp.

◆ toXML()

DOM_Element TYPlanEau::toXML ( DOM_Element & domElement )

virtual

Construit une arborescence DOM a partir du noeud passe afin de sauvegarder les parametres au format XML.

Parameters

domElement Le noeud DOM parent a partir duquel l'arborescence doit etre creee.

Returns: Le noeud DOM nouvellement cree.

Reimplemented from TYTerrain.

Definition at line 115 of file TYPlanEau.cpp.

Here is the call graph for this function:

◆ updateDistMax()

void TYPlanEau::updateDistMax ( )

inline

Mise a jour de la distance max

Definition at line 137 of file TYPlanEau.h.

Here is the call graph for this function:

Member Data Documentation

◆ _pCrbNiv

LPTYCourbeNiveau TYPlanEau::_pCrbNiv

protected

Une courbe de niveau correspondant a ce plan d'eau.

Definition at line 147 of file TYPlanEau.h.

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

/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/models/business/topography/TYPlanEau.h
/home/docs/checkouts/readthedocs.org/user_builds/codetympan/checkouts/latest/Tympan/models/business/topography/TYPlanEau.cpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TYPlanEau() [1/3]

◆ TYPlanEau() [2/3]

◆ TYPlanEau() [3/3]

◆ ~TYPlanEau()

Member Function Documentation

◆ deepCopy()

◆ fromXML()

◆ getAltitude()

◆ getCrbNiv()

◆ getDistMax() [1/2]

◆ getDistMax() [2/2]

◆ getIsDMaxDefault() [1/2]

◆ getIsDMaxDefault() [2/2]

◆ getListPoints() [1/2]

◆ getListPoints() [2/2]

◆ offsetListPoints()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setAltitude()

◆ setCrbNiv()

◆ setDistMax()

◆ setIsDMaxDefault()

◆ setIsGeometryModified()

◆ setListPoints()

◆ toString()

◆ toXML()

◆ updateDistMax()

Member Data Documentation

◆ _pCrbNiv