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

This class represents a polyline with a thickness. Acoustic receptors are sampled inside this region. More...

#include <TYBoundaryNoiseMap.h>

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

Public Member Functions

 TYBoundaryNoiseMap ()
 Constructor. TYBoundaryNoiseMap constructor. More...
 
 TYBoundaryNoiseMap (const TYBoundaryNoiseMap &other)
 Copy constructor. TYBoundaryNoiseMap copy constructor. More...
 
virtual ~TYBoundaryNoiseMap ()
 Destructor. TYBoundaryNoiseMap destructor. More...
 
TYBoundaryNoiseMapoperator= (const TYBoundaryNoiseMap &other)
 Operator =. More...
 
bool operator== (const TYBoundaryNoiseMap &other) const
 Operator ==. More...
 
bool operator!= (const TYBoundaryNoiseMap &other) const
 Operator !=. 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)
 
bool toXML (const std::string &sFilePath)
 
bool fromXML (const std::string &sFilePath)
 
std::string toXMLString ()
 
bool fromXMLString (const std::string &sXMLString)
 
virtual void clearResult ()
 Clear result. More...
 
virtual void make (const TYTabPoint &tabPoints, double thickness, bool closed, double density=TY_MAILLAGE_DEFAULT_DENSITE)
 Build the table of TYPointCalcul around the polyline. More...
 
void computeBoundingBox (double &box_x_min, double &box_x_max, double &box_y_min, double &box_y_max) const
 Compute the bounding box of the polyline. More...
 
void computePoints (double box_x_min, double box_x_max, double box_y_min, double box_y_max)
 Compute the calcul points. More...
 
double getDensity () const
 Return the density of points. More...
 
double getThickness () const
 Return the thickness of the polyline. More...
 
bool isClosed () const
 Is polyline closed? More...
 
const TYPointgetPosLabel ()
 Return the position that will be used for the legend/label display. More...
 
const TYTabPointgetTabPoint () const
 Return the points defining the polyline. More...
 
TYTabPointgetTabPoint ()
 Return the points defining the polyline. More...
 
const std::vector< int > & getPtsIndices () const
 Return the indices of calcul points. More...
 
std::vector< int > & getPtsIndices ()
 Return the indices of calcul points. More...
 
int getNbPointsY () const
 Return number of points in column, for the 2D array. More...
 
virtual int getIndexPtCalcul (int x, int y) const
 Return the index. More...
 
virtual void getDimensions (int &x, int &y) const
 Return the dimensions in x and y. More...
 
bool getCanBeClosed () const
 Getter of _canBeClosed. More...
 
void setCanBeClosed (bool canBeClosed)
 Setter of _canBeClosed. More...
 
- Public Member Functions inherited from TYMaillage
 TYMaillage ()
 Constructeur. Constructeur de la classe TYMaillage. More...
 
 TYMaillage (const TYMaillage &other)
 Constructeur par copie. Constructeur par copie de la classe TYMaillage. More...
 
virtual ~TYMaillage ()
 Destructeur Destructeur de la classe TYMaillage. More...
 
TYMaillageoperator= (const TYMaillage &other)
 Operateur =. More...
 
bool operator== (const TYMaillage &other) const
 Operateur ==. More...
 
bool operator!= (const TYMaillage &other) const
 Operateur !=. More...
 
void exportCSV (const std::string &fileName)
 export mesh to csv file More...
 
virtual void updateFromCalcul (LPTYCalcul pCalcul)
 get datas from calcul void updateFromCalcul(LPTYCalcul pCalcul) More...
 
TYTabLPPointCalculgetPtsCalcul ()
 Set/Get de la liste des points de calcul. More...
 
const TYTabLPPointCalculgetPtsCalcul () const
 
void setPtsCalcul (const TYTabLPPointCalcul &list)
 
bool addPointCalcul (LPTYPointCalcul pPtCalcul)
 Ajoute un nouveau point de calcul. More...
 
bool remPointCalcul (const LPTYPointCalcul pPtCalcul)
 Supprime une entree a la liste des points de calculs. More...
 
bool remPointCalcul (QString idPtCalcul)
 Supprime une entree a la liste des points de calculs a partir de son identifiant. More...
 
void remAllPointCalcul ()
 Suppression de tous les elements. More...
 
void setHauteur (double hauteur)
 Set/Get de la hauteur de ce maillage par rapport au sol (a l'altimetrie en fait). More...
 
double getHauteur () const
 
void setComputeAlti (bool state)
 Set/Get de l'indicateur de calcul de l'altitude des points de ce maillage. More...
 
bool getComputeAlti () const
 
void setDataType (int type)
 Set/Get de l'indicateur de type des donnees a representer. More...
 
int getDataType ()
 
void setDataFreq (float freq)
 Set/Get de la frequence des donnees a representer lorsque _dataType vaut DataFreq. More...
 
float getDataFreq ()
 
void setPalette (LPTYPalette pPalette)
 Set/Get de la palette. More...
 
LPTYPalette getPalette ()
 
void setPanel (LPTYPanel pPanel)
 Set du panel. More...
 
LPTYPanel getPanel ()
 Get du panel. More...
 
void make (const TYTabPoint &points)
 Rempli la structure de points de calcul a partir d'un tableau de points classiques. More...
 
void computeMesh (std::vector< MTriangle > &mesh) const
 Compute the mesh. More...
 
MTriangle computeTriangle (TYPointCalcul &pt1, TYPointCalcul &pt2, TYPointCalcul &pt3) const
 Compute the triangle. More...
 
double getSpectrumValue (TYPointCalcul &pt) const
 Get the spectrum value of a calcul point. More...
 
void computeIsoCurve (std::vector< MTriangle > &mesh, std::vector< MPoint > &isoCurve) const
 Compute the isocurve. More...
 
bool computeIsoPoint (const OHPlane3D &plane, const MPoint &pt1, const MPoint &pt2, MPoint &mp) const
 Compute an isopoint by interpolating the value if the segment intersects the plane. More...
 
virtual void setEtat (const TYUUID &id_calc, bool etat)
 
virtual bool etat ()
 
virtual bool etat (const TYUUID &id_calc)
 
virtual bool etat (const TYCalcul *pCalc)
 
void copyEtats (TYMaillage *pOther)
 Copie du map calcul-etat. More...
 
void duplicateEtat (const TYUUID &idCalculRef, const TYUUID &idCalculNew)
 Duplique l'etat defini pour un calcul pour un autre calcul. More...
 
bool remEtat (TYCalcul *pCalcul)
 Remove calcul from "etat" map. 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
 

Static Public Member Functions

static double computeMinimumDensity (double thickness)
 Return the minimum density to get a correct sampling. More...
 
- Static Public Member Functions inherited from TYMaillage
static bool checkSimilar (const TYMaillage *const pMaillage1, const TYMaillage *const pMaillage2)
 
- 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)
 

Protected Attributes

TYPoint _posLabel
 The position of the label. More...
 
double _density
 Density of points (number of points per meter). More...
 
double _thickness
 Thickness of the polyline (in meters). More...
 
bool _closed
 If the polyline is closed. More...
 
TYTabPoint _tabPoint
 The tab point defining the polyline. More...
 
std::vector< int > _ptsIndices
 Array of points indices : -1 means the point doesn't exist. More...
 
int _nbPointsY
 Number of points in column y (rectangular bounding box). More...
 
bool _canBeClosed
 If the polyline can be closed. More...
 
- Protected Attributes inherited from TYMaillage
TYTabLPPointCalcul _ptsCalcul
 Liste des points de calcul. More...
 
TYMapIdBool _tabEtats
 L'etat du maillage pour un calcul donne. More...
 
double _hauteur
 La hauteur par rapport au sol (a l'altimetrie en fait) a laquelle se trouve ce maillage. More...
 
bool _computeAlti
 Indique si l'altitude des points constituant ce maillage doit etre calculee. More...
 
int _dataType
 Indique le type des donnees a representer. More...
 
float _dataFreq
 La frequence des donnees a representer lorsque _dataType vaut DataFreq. More...
 
LPTYPalette _pPalette
 Palette. More...
 
LPTYPanel _pPanel
 Panel. 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...
 

Additional Inherited Members

- Public Types inherited from TYMaillage
enum  MaillageDataType { ValGlobalDBA, ValGlobalDBLin, DataFreq }
 Les differents type pour les donnees a representer. More...
 
enum  MaillageState { Actif, Inactif }
 Etat du Maillage : Actif / Bloque. More...
 
- Protected Member Functions inherited from OPrototype
 OPrototype ()
 

Detailed Description

This class represents a polyline with a thickness. Acoustic receptors are sampled inside this region.

Version
v 1.1
Date
2013/05/06
Author
Projet_Tympan

Definition at line 40 of file TYBoundaryNoiseMap.h.

Constructor & Destructor Documentation

◆ TYBoundaryNoiseMap() [1/2]

TYBoundaryNoiseMap::TYBoundaryNoiseMap ( )

Constructor. TYBoundaryNoiseMap constructor.

Definition at line 73 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ TYBoundaryNoiseMap() [2/2]

TYBoundaryNoiseMap::TYBoundaryNoiseMap ( const TYBoundaryNoiseMap other)

Copy constructor. TYBoundaryNoiseMap copy constructor.

Definition at line 84 of file TYBoundaryNoiseMap.cpp.

◆ ~TYBoundaryNoiseMap()

TYBoundaryNoiseMap::~TYBoundaryNoiseMap ( )
virtual

Destructor. TYBoundaryNoiseMap destructor.

Definition at line 89 of file TYBoundaryNoiseMap.cpp.

Member Function Documentation

◆ clearResult()

void TYBoundaryNoiseMap::clearResult ( )
virtual

Clear result.

Reimplemented from TYMaillage.

Definition at line 320 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ computeBoundingBox()

void TYBoundaryNoiseMap::computeBoundingBox ( double &  box_x_min,
double &  box_x_max,
double &  box_y_min,
double &  box_y_max 
) const

Compute the bounding box of the polyline.

Parameters
box_x_minlower left coordinate.
box_x_maxlower right coordinate.
box_y_minhigher left coordinate.
box_y_maxhigher right coordinate.

Definition at line 352 of file TYBoundaryNoiseMap.cpp.

Here is the caller graph for this function:

◆ computeMinimumDensity()

double TYBoundaryNoiseMap::computeMinimumDensity ( double  thickness)
static

Return the minimum density to get a correct sampling.

Parameters
thicknessThe thickness to test
Returns
The minimum density.

Definition at line 431 of file TYBoundaryNoiseMap.cpp.

Here is the caller graph for this function:

◆ computePoints()

void TYBoundaryNoiseMap::computePoints ( double  box_x_min,
double  box_x_max,
double  box_y_min,
double  box_y_max 
)

Compute the calcul points.

Parameters
box_x_minlower left coordinate.
box_x_maxlower right coordinate.
box_y_minhigher left coordinate.
box_y_maxhigher right coordinate.

Definition at line 382 of file TYBoundaryNoiseMap.cpp.

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

◆ deepCopy()

bool TYBoundaryNoiseMap::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 TYMaillage.

Definition at line 125 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ fromXML() [1/2]

int TYBoundaryNoiseMap::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 TYMaillage.

Definition at line 167 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ fromXML() [2/2]

bool TYBoundaryNoiseMap::fromXML ( const std::string &  sFilePath)

Definition at line 256 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ fromXMLString()

bool TYBoundaryNoiseMap::fromXMLString ( const std::string &  sXMLString)

Definition at line 297 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ getCanBeClosed()

bool TYBoundaryNoiseMap::getCanBeClosed ( ) const
inline

Getter of _canBeClosed.

Returns
_canBeClosed

Definition at line 211 of file TYBoundaryNoiseMap.h.

Here is the caller graph for this function:

◆ getDensity()

double TYBoundaryNoiseMap::getDensity ( ) const
inline

Return the density of points.

Returns
_density

Definition at line 134 of file TYBoundaryNoiseMap.h.

◆ getDimensions()

void TYBoundaryNoiseMap::getDimensions ( int &  x,
int &  y 
) const
virtual

Return the dimensions in x and y.

Parameters
xDimension x
yDimension y

Reimplemented from TYMaillage.

Definition at line 441 of file TYBoundaryNoiseMap.cpp.

Here is the caller graph for this function:

◆ getIndexPtCalcul()

int TYBoundaryNoiseMap::getIndexPtCalcul ( int  x,
int  y 
) const
virtual

Return the index.

Parameters
xRow value
yColumn value
Returns
The index of point calcul

Reimplemented from TYMaillage.

Definition at line 436 of file TYBoundaryNoiseMap.cpp.

Here is the caller graph for this function:

◆ getNbPointsY()

int TYBoundaryNoiseMap::getNbPointsY ( ) const
inline

Return number of points in column, for the 2D array.

Returns
The number of points in y.

Definition at line 183 of file TYBoundaryNoiseMap.h.

Here is the call graph for this function:

◆ getPosLabel()

const TYPoint& TYBoundaryNoiseMap::getPosLabel ( )
inline

Return the position that will be used for the legend/label display.

Returns
A const reference to a point.

Definition at line 153 of file TYBoundaryNoiseMap.h.

◆ getPtsIndices() [1/2]

const std::vector<int>& TYBoundaryNoiseMap::getPtsIndices ( ) const
inline

Return the indices of calcul points.

Returns
A const reference to the points.

Definition at line 171 of file TYBoundaryNoiseMap.h.

◆ getPtsIndices() [2/2]

std::vector<int>& TYBoundaryNoiseMap::getPtsIndices ( )
inline

Return the indices of calcul points.

Returns
A reference to the points.

Definition at line 177 of file TYBoundaryNoiseMap.h.

◆ getTabPoint() [1/2]

const TYTabPoint& TYBoundaryNoiseMap::getTabPoint ( ) const
inline

Return the points defining the polyline.

Returns
A const reference to the points.

Definition at line 159 of file TYBoundaryNoiseMap.h.

◆ getTabPoint() [2/2]

TYTabPoint& TYBoundaryNoiseMap::getTabPoint ( )
inline

Return the points defining the polyline.

Returns
A reference to the points.

Definition at line 165 of file TYBoundaryNoiseMap.h.

◆ getThickness()

double TYBoundaryNoiseMap::getThickness ( ) const
inline

Return the thickness of the polyline.

Returns
_thickness

Definition at line 141 of file TYBoundaryNoiseMap.h.

◆ isClosed()

bool TYBoundaryNoiseMap::isClosed ( ) const
inline

Is polyline closed?

Returns
True if the polyline is closed.

Definition at line 147 of file TYBoundaryNoiseMap.h.

Here is the caller graph for this function:

◆ make()

void TYBoundaryNoiseMap::make ( const TYTabPoint tabPoints,
double  thickness,
bool  closed,
double  density = TY_MAILLAGE_DEFAULT_DENSITE 
)
virtual

Build the table of TYPointCalcul around the polyline.

Parameters
tabPointsArray of points.
thicknessThe thickness of the polyline.
closedIf the polyline is closed.
densityDensity of points (number of points per meter).

Definition at line 326 of file TYBoundaryNoiseMap.cpp.

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

◆ operator!=()

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

Operator !=.

Definition at line 120 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ operator=()

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

Operator =.

Definition at line 93 of file TYBoundaryNoiseMap.cpp.

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

◆ operator==()

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

Operator ==.

Definition at line 108 of file TYBoundaryNoiseMap.cpp.

Here is the caller graph for this function:

◆ setCanBeClosed()

void TYBoundaryNoiseMap::setCanBeClosed ( bool  canBeClosed)
inline

Setter of _canBeClosed.

Parameters
canBeClosedIf the poyline can be closed or not.

Definition at line 217 of file TYBoundaryNoiseMap.h.

◆ toString()

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

Definition at line 143 of file TYBoundaryNoiseMap.cpp.

◆ toXML() [1/2]

DOM_Element TYBoundaryNoiseMap::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 TYMaillage.

Definition at line 148 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ toXML() [2/2]

bool TYBoundaryNoiseMap::toXML ( const std::string &  sFilePath)

Definition at line 223 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

◆ toXMLString()

std::string TYBoundaryNoiseMap::toXMLString ( )

Definition at line 285 of file TYBoundaryNoiseMap.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ _canBeClosed

bool TYBoundaryNoiseMap::_canBeClosed
protected

If the polyline can be closed.

Definition at line 243 of file TYBoundaryNoiseMap.h.

◆ _closed

bool TYBoundaryNoiseMap::_closed
protected

If the polyline is closed.

Definition at line 231 of file TYBoundaryNoiseMap.h.

◆ _density

double TYBoundaryNoiseMap::_density
protected

Density of points (number of points per meter).

Definition at line 225 of file TYBoundaryNoiseMap.h.

◆ _nbPointsY

int TYBoundaryNoiseMap::_nbPointsY
protected

Number of points in column y (rectangular bounding box).

Definition at line 240 of file TYBoundaryNoiseMap.h.

◆ _posLabel

TYPoint TYBoundaryNoiseMap::_posLabel
protected

The position of the label.

Definition at line 222 of file TYBoundaryNoiseMap.h.

◆ _ptsIndices

std::vector<int> TYBoundaryNoiseMap::_ptsIndices
protected

Array of points indices : -1 means the point doesn't exist.

Definition at line 237 of file TYBoundaryNoiseMap.h.

◆ _tabPoint

TYTabPoint TYBoundaryNoiseMap::_tabPoint
protected

The tab point defining the polyline.

Definition at line 234 of file TYBoundaryNoiseMap.h.

◆ _thickness

double TYBoundaryNoiseMap::_thickness
protected

Thickness of the polyline (in meters).

Definition at line 228 of file TYBoundaryNoiseMap.h.


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