Code_TYMPAN  4.2.0
Industrial site acoustic simulation
Public Member Functions | List of all members
TYPoint Class Reference

#include <TYPoint.h>

Inheritance diagram for TYPoint:
Inheritance graph
[legend]
Collaboration diagram for TYPoint:
Collaboration graph
[legend]

Public Member Functions

 TYPoint (bool PutInInstanceList=false)
 
 TYPoint (const TYPoint &other, bool PutInInstanceList=false)
 
 TYPoint (const OCoord3D &other, bool PutInInstanceList=false)
 
 TYPoint (const OVector3D &other, bool PutInInstanceList=false)
 
 TYPoint (double x, double y, double z, bool PutInInstanceList=false)
 
virtual ~TYPoint ()
 
TYPointoperator= (const TYPoint &other)
 Operateur =. More...
 
bool operator== (const TYPoint &other) const
 Operateur ==. More...
 
bool operator!= (const TYPoint &other) const
 Operateur !=. More...
 
bool isEqual (const TYPoint &point) const
 Tests equality using only coordiantes. 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)
 
OPoint3Ddowncast_opoint ()
 return TYPoint casted as OPoint3D More...
 
- 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 TYUUIDgetID () 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)
 
TYElementgetParent () const
 
virtual void setIsAcousticModified (bool isModified)
 
bool getIsAcousticModified ()
 
virtual void setIsGeometryModified (bool isModified)
 
bool getIsGeometryModified ()
 
TYElementoperator= (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 OPrototypeclone () const =0
 
virtual const char * getClassName () const
 
bool isA (const char *className) const
 
- Public Member Functions inherited from OPoint3D
 OPoint3D ()
 Default constructor. More...
 
 OPoint3D (const OPoint3D &pt)
 Copy constructor. More...
 
 OPoint3D (const OCoord3D &coord)
 Constructor from a 3D coord. More...
 
 OPoint3D (double x, double y, double z)
 Constructs a new object from 3 doubles. More...
 
 OPoint3D (double v[])
 Constructs a new object from 3 doubles. More...
 
virtual ~OPoint3D ()
 Destructor. More...
 
virtual void set (double x, double y, double z)
 
virtual void setFromOGL (double x, double y, double z)
 
virtual void setFromOGL (float x, float y, float z)
 
virtual void setFromOGL (float coords[3])
 
virtual void setFromOGL (double coords[3])
 
virtual void getToOGL (double &x, double &y, double &z)
 
virtual void getToOGL (double coords[3])
 
double distFrom (const OPoint3D &pt) const
 Computes the distance from this point to another. More...
 
double dist2DFrom (const OPoint3D &pt) const
 Computes the distance from this point to another in 2D plan. More...
 
bool isEqual (const OPoint3D &oPoint) const
 Compatibility alias for operator==. More...
 
 OPoint3D ()
 Default constructor. More...
 
 OPoint3D (const OPoint3D &pt)
 Copy constructor. More...
 
 OPoint3D (const OCoord3D &coord)
 Constructor from a 3D coord. More...
 
 OPoint3D (double x, double y, double z)
 
 OPoint3D (double v[])
 
virtual ~OPoint3D ()
 Destructor. More...
 
virtual void set (double x, double y, double z)
 
virtual void setFromOGL (double x, double y, double z)
 
virtual void setFromOGL (float x, float y, float z)
 
virtual void setFromOGL (float coords[3])
 
virtual void setFromOGL (double coords[3])
 
virtual void getToOGL (double &x, double &y, double &z)
 
virtual void getToOGL (double coords[3])
 
double distFrom (const OPoint3D &pt) const
 
double dist2DFrom (const OPoint3D &pt) const
 
bool isEqual (const OPoint3D &oPoint) const
 Compatibility alias for operator==. More...
 
- Public Member Functions inherited from OCoord3D
 OCoord3D ()
 Default constructor. More...
 
 OCoord3D (const OCoord3D &coord)
 Copy constructor. More...
 
 OCoord3D (double x, double y, double z)
 Constructor with 3D point coordinates. More...
 
virtual ~OCoord3D ()
 Destructor. More...
 
OCoord3Doperator= (const OCoord3D &coord)
 operator= More...
 
bool operator== (const OCoord3D &coord) const
 operator== More...
 
bool operator!= (const OCoord3D &coord) const
 operator!= More...
 
void setCoords (double x, double y, double z)
 Sets the coordinates as an array of double. More...
 
void setCoords (double coords[3])
 Sets the coordinates as an array of double. More...
 
void getCoords (double coords[3])
 Gets the coordinates as an array of double. More...
 
double * getCoords ()
 Gets the coordinates as an array of double. More...
 
 operator const double * () const
 
 operator double * ()
 
 OCoord3D ()
 Default constructor. More...
 
 OCoord3D (const OCoord3D &coord)
 Copy constructor. More...
 
 OCoord3D (double x, double y, double z)
 Constructor with 3D point coordinates. More...
 
virtual ~OCoord3D ()
 Destructor. More...
 
OCoord3Doperator= (const OCoord3D &coord)
 operator= More...
 
bool operator== (const OCoord3D &coord) const
 operator== More...
 
bool operator!= (const OCoord3D &coord) const
 operator!= More...
 
void setCoords (double x, double y, double z)
 
void setCoords (double coords[3])
 
void getCoords (double coords[3])
 
double * getCoords ()
 
 operator const double * () const
 
 operator double * ()
 

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 TYElementgetInstance (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 OPrototypefindAndClone (const char *className)
 
static int findPrototype (const char *className)
 
static OPrototypesafeDownCast (OPrototype *pObject)
 
static void add_factory (const char *, IOProtoFactory::ptr_type factory)
 
- Static Public Member Functions inherited from OPoint3D
static TabPoint3D checkPointsMaxDistance (const TabPoint3D &points, const double &distanceMax)
 
static TabPoint3D checkPointsMaxDistance (const OPoint3D &point1, const OPoint3D &point2, const double &distanceMax)
 Same as previous function taking two points instead of a tab of points. More...
 
static TabPoint3D checkPointsMaxDistance (const TabPoint3D &points, const double &distanceMax)
 
static TabPoint3D checkPointsMaxDistance (const OPoint3D &point1, const OPoint3D &point2, const double &distanceMax)
 Same as previous function taking two points instead of a tab of points. More...
 
- Public Attributes inherited from OCoord3D
union {
   struct {
      double   _x
 x coordinate of OCoord3D More...
 
      double   _y
 y coordinate of OCoord3D More...
 
      double   _z
 z coordinate of OCoord3D More...
 
   } 
 
   double   _value [3]
 
}; 
 
union {
   struct {
      double   _x
 x coordinate of OCoord3D More...
 
      double   _y
 y coordinate of OCoord3D More...
 
      double   _z
 z coordinate of OCoord3D More...
 
   } 
 
   double   _value [3]
 
}; 
 
- Protected Member Functions inherited from OPrototype
 OPrototype ()
 
- 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...
 

Detailed Description

Classe de definition d'un point.

Definition at line 30 of file TYPoint.h.

Constructor & Destructor Documentation

◆ TYPoint() [1/5]

TYPoint::TYPoint ( bool  PutInInstanceList = false)

Constructeur par defaut.

Definition at line 33 of file TYPoint.cpp.

◆ TYPoint() [2/5]

TYPoint::TYPoint ( const TYPoint other,
bool  PutInInstanceList = false 
)

Constructeur de copie.

Definition at line 37 of file TYPoint.cpp.

◆ TYPoint() [3/5]

TYPoint::TYPoint ( const OCoord3D other,
bool  PutInInstanceList = false 
)

Constructeur de copie.

Definition at line 42 of file TYPoint.cpp.

◆ TYPoint() [4/5]

TYPoint::TYPoint ( const OVector3D other,
bool  PutInInstanceList = false 
)

Constructeur de copie.

Definition at line 47 of file TYPoint.cpp.

◆ TYPoint() [5/5]

TYPoint::TYPoint ( double  x,
double  y,
double  z,
bool  PutInInstanceList = false 
)

Constructeur.

Definition at line 52 of file TYPoint.cpp.

◆ ~TYPoint()

TYPoint::~TYPoint ( )
virtual

Destructeur.

Definition at line 57 of file TYPoint.cpp.

Member Function Documentation

◆ deepCopy()

bool TYPoint::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
pOtherL'element a copier.
copyIdCopie l'identifiant unique ou pas.
Returns
true si la copie est possible; false sinon.

Reimplemented from TYElement.

Reimplemented in TYPointCalcul, and TYPointControl.

Definition at line 93 of file TYPoint.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ downcast_opoint()

OPoint3D* TYPoint::downcast_opoint ( )
inline

return TYPoint casted as OPoint3D

Definition at line 83 of file TYPoint.h.

◆ fromXML()

int TYPoint::fromXML ( DOM_Element  domElement)
virtual

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

Parameters
domElementLe noeud DOM a partir duquel les parametres doivent etre recuperes.
Returns
1 si la recuperation des parametres a reussie.

Reimplemented from TYElement.

Reimplemented in TYPointCalcul, and TYPointControl.

Definition at line 129 of file TYPoint.cpp.

Here is the call graph for this function:

◆ isEqual()

bool TYPoint::isEqual ( const TYPoint point) const

Tests equality using only coordiantes.

Definition at line 88 of file TYPoint.cpp.

Here is the call graph for this function:

◆ operator!=()

bool TYPoint::operator!= ( const TYPoint other) const

Operateur !=.

Definition at line 83 of file TYPoint.cpp.

Here is the call graph for this function:

◆ operator=()

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

Operateur =.

Definition at line 61 of file TYPoint.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator==()

bool TYPoint::operator== ( const TYPoint other) const

Operateur ==.

Definition at line 72 of file TYPoint.cpp.

Here is the caller graph for this function:

◆ toString()

std::string TYPoint::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 TYElement.

Reimplemented in TYPointCalcul, and TYPointControl.

Definition at line 104 of file TYPoint.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ toXML()

DOM_Element TYPoint::toXML ( DOM_Element domElement)
virtual

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

Parameters
domElementLe noeud DOM parent a partir duquel l'arborescence doit etre creee.
Returns
Le noeud DOM nouvellement cree.

Reimplemented from TYElement.

Reimplemented in TYPointCalcul, and TYPointControl.

Definition at line 110 of file TYPoint.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

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