Code_TYMPAN  4.4.0
Industrial site acoustic simulation
TYEtape.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) <2012-2024> <EDF-DTG> <FRANCE>
3  * This file is part of Code_TYMPAN (R).
4  * Code_TYMPAN (R) is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation, either version 3 of the License, or
7  * (at your option) any later version.
8  * Code_TYMPAN (R) is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
11  * See the GNU General Public License for more details.
12  * You should have received a copy of the GNU General Public License along
13  * with Code_TYMPAN (R). If not, see <https://www.gnu.org/licenses/>.
14  */
15 
16 /*
17  *
18  *
19  *
20  *
21  */
22 
23 #ifndef __TY_ETAPE__
24 #define __TY_ETAPE__
25 
28 
29 #include <deque>
30 
44 class TYEtape
45 {
46  // Methods
47 public:
52  TYEtape();
57  TYEtape(const TYEtape& other);
63  virtual ~TYEtape();
64 
66  TYEtape& operator=(const TYEtape& other);
68  bool operator==(const TYEtape& other) const;
70  bool operator!=(const TYEtape& other) const;
78  {
79  return _type;
80  }
84  void setType(ACOUSTIC_EVENT_TYPES etapeType)
85  {
86  _type = etapeType;
87  }
88 
96  {
97  return _pt;
98  }
99  void setPoint(const OPoint3D& pt)
100  {
101  _pt = pt;
102  }
103 
104  acoustic_event* asEvent() const;
105 
106  // Membres
107 public:
110 };
111 
113 typedef std::deque<TYEtape> TYTabEtape;
114 
115 #endif // __TY_ETAPE__
std::deque< TYEtape > TYTabEtape
TYEtape collection.
Definition: TYEtape.h:113
ACOUSTIC_EVENT_TYPES
Definition: acoustic_path.h:22
The 3D point class.
Definition: 3d.h:487
The TYEtape class is used to describe a part (a step) of a path (TYChemin) for the computation of tra...
Definition: TYEtape.h:45
OPoint3D _pt
The starting point of this step.
Definition: TYEtape.h:109
TYEtape & operator=(const TYEtape &other)
Operator =.
Definition: TYEtape.cpp:27
bool operator!=(const TYEtape &other) const
Operator !=.
Definition: TYEtape.cpp:63
ACOUSTIC_EVENT_TYPES _type
Acoustic event type.
Definition: TYEtape.h:108
bool operator==(const TYEtape &other) const
Operator ==.
Definition: TYEtape.cpp:39
TYEtape()
Constructor.
Definition: TYEtape.cpp:18
acoustic_event * asEvent() const
Definition: TYEtape.cpp:68
ACOUSTIC_EVENT_TYPES getType() const
Set/Get du type de cette etape.
Definition: TYEtape.h:77
void setPoint(const OPoint3D &pt)
Definition: TYEtape.h:99
OPoint3D getPoint() const
Get/Set of the first point of the step.
Definition: TYEtape.h:95
virtual ~TYEtape()
Destructor.
Definition: TYEtape.cpp:25
void setType(ACOUSTIC_EVENT_TYPES etapeType)
Definition: TYEtape.h:84
This class store data and provide functions to manipulate event in the acoustic context.
Definition: acoustic_path.h:40