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

#include <TYSegment.h>

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

Public Member Functions

 TYSegment ()
 
 TYSegment (const TYSegment &other)
 
 TYSegment (TYPoint ptA, TYPoint ptB)
 
virtual ~TYSegment ()
 
virtual TYSegmentoperator= (const TYSegment &other)
 Operateur =. More...
 
virtual bool operator== (const TYSegment &other) const
 Operateur ==. More...
 
virtual bool operator!= (const TYSegment &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)
 
- 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 OSegment3D
 OSegment3D ()
 Default constructor. More...
 
 OSegment3D (const OSegment3D &other)
 Copy constructor. More...
 
 OSegment3D (const OPoint3D &ptA, const OPoint3D &ptB)
 
virtual ~OSegment3D ()
 Destructor. More...
 
virtual OSegment3Doperator= (const OSegment3D &other)
 operator= More...
 
virtual bool operator== (const OSegment3D &other) const
 operator== More...
 
virtual bool operator!= (const OSegment3D &other) const
 operator!= More...
 
virtual OSegment3D operator* (const OMatrix &matrix) const
 Multiplication with a matrix. More...
 
virtual double longueur () const
 Return the segment length. More...
 
virtual int symetrieOf (const OPoint3D &pt, OPoint3D &ptSym) const
 Return the symmetrical of a point. More...
 
virtual int projection (const OPoint3D &pt, OPoint3D &ptProj, double seuilConfondus) const
 Return the projection of a point. More...
 
virtual int intersects (const OSegment3D &seg, OPoint3D &pt, double seuilConfondus) const
 Return the intersection point with another segment. More...
 
virtual OPoint3D centreOf () const
 Return the position of the segment middle. More...
 
virtual OPoint3D centerOfCurvedPath (const double &R) const
 Return the position of the arc circle center of radius R passing by the segment extremities. More...
 
virtual double lengthOfCurvedPath (const double &R)
 Calculate the path length of radius R passing by the segment extremities. More...
 
virtual OVector3D toVector3D () const
 Build a OVector3D from a segment used for the direction of the sources. More...
 
virtual OSegment3D swap () const
 Return the segment. More...
 
 OSegment3D ()
 Default constructor. More...
 
 OSegment3D (const OSegment3D &other)
 Copy constructor. More...
 
 OSegment3D (const OPoint3D &ptA, const OPoint3D &ptB)
 
virtual ~OSegment3D ()
 Destructor. More...
 
virtual OSegment3Doperator= (const OSegment3D &other)
 operator= More...
 
virtual bool operator== (const OSegment3D &other) const
 operator== More...
 
virtual bool operator!= (const OSegment3D &other) const
 operator!= More...
 
virtual OSegment3D operator* (const OMatrix &matrix) const
 
virtual double longueur () const
 
virtual int symetrieOf (const OPoint3D &pt, OPoint3D &ptSym) const
 
virtual int projection (const OPoint3D &pt, OPoint3D &ptProj, double seuilConfondus) const
 
virtual int intersects (const OSegment3D &seg, OPoint3D &pt, double seuilConfondus) const
 
virtual OPoint3D centreOf () const
 
virtual OPoint3D centerOfCurvedPath (const double &R) const
 
virtual double lengthOfCurvedPath (const double &R)
 
virtual OVector3D toVector3D () const
 
virtual OSegment3D swap () const
 
- Public Member Functions inherited from TYColorInterface
virtual void updateColor ()
 
 TYColorInterface ()
 
 TYColorInterface (const TYColorInterface &other)
 
virtual ~TYColorInterface ()
 
TYColorInterfaceoperator= (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
 

Static Public Member Functions

static bool unorderedIsEqual (const TYSegment &s1, const TYSegment &s2)
 Comparison function for unordered segment. More...
 
- 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)
 

Additional Inherited Members

- Public Attributes inherited from OSegment3D
OPoint3D _ptA
 Point A of the segment. More...
 
OPoint3D _ptB
 Point B of the segment. More...
 
- 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...
 
- Protected Attributes inherited from TYColorInterface
OColor _color
 

Detailed Description

Classe de definition d'un segment.

Definition at line 34 of file TYSegment.h.

Constructor & Destructor Documentation

◆ TYSegment() [1/3]

TYSegment::TYSegment ( )

Constructeur par defaut.

Definition at line 29 of file TYSegment.cpp.

Here is the call graph for this function:

◆ TYSegment() [2/3]

TYSegment::TYSegment ( const TYSegment other)

Constructeur par copie.

Definition at line 37 of file TYSegment.cpp.

◆ TYSegment() [3/3]

TYSegment::TYSegment ( TYPoint  ptA,
TYPoint  ptB 
)

Constructeur a partir de 2 points.

Definition at line 42 of file TYSegment.cpp.

Here is the call graph for this function:

◆ ~TYSegment()

TYSegment::~TYSegment ( )
virtual

Destructeur.

Definition at line 50 of file TYSegment.cpp.

Member Function Documentation

◆ deepCopy()

bool TYSegment::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.

Definition at line 83 of file TYSegment.cpp.

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

◆ fromXML()

int TYSegment::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.

Definition at line 117 of file TYSegment.cpp.

Here is the call graph for this function:

◆ operator!=()

bool TYSegment::operator!= ( const TYSegment other) const
virtual

Operateur !=.

Definition at line 78 of file TYSegment.cpp.

Here is the call graph for this function:

◆ operator=()

TYSegment & TYSegment::operator= ( const TYSegment other)
virtual

Operateur =.

Definition at line 54 of file TYSegment.cpp.

Here is the call graph for this function:

◆ operator==()

bool TYSegment::operator== ( const TYSegment other) const
virtual

Operateur ==.

Definition at line 66 of file TYSegment.cpp.

Here is the caller graph for this function:

◆ toString()

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

Definition at line 97 of file TYSegment.cpp.

◆ toXML()

DOM_Element TYSegment::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.

Definition at line 103 of file TYSegment.cpp.

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

◆ unorderedIsEqual()

bool TYSegment::unorderedIsEqual ( const TYSegment s1,
const TYSegment s2 
)
static

Comparison function for unordered segment.

Parameters
s1Segment 1.
s2Segment 2.
Returns
True if the two segments are equal

Definition at line 151 of file TYSegment.cpp.


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