A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
building.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Marco Miozzo <marco.miozzo@cttc.es>
19  *
20  */
21 #ifndef BUILDING_H
22 #define BUILDING_H
23 
24 #include <ns3/attribute.h>
25 #include <ns3/attribute-helper.h>
26 #include <ns3/vector.h>
27 #include <ns3/box.h>
28 #include <ns3/simple-ref-count.h>
29 #include <ns3/object.h>
30 
31 namespace ns3 {
32 
37 class Building : public Object
38 {
39 public:
40 
41  // inherited from Object
42  static TypeId GetTypeId (void);
43  virtual void DoDispose ();
44 
45 
47  {
49  };
51  {
53  };
54 
66  Building (double xMin,
67  double xMax,
68  double yMin,
69  double yMax,
70  double zMin,
71  double zMax);
72 
77  Building ();
78 
83  virtual ~Building ();
84 
89  uint32_t GetId (void) const;
90 
96  void SetBoundaries (Box box);
97 
104 
113 
120  void SetNFloors (uint16_t nfloors);
121 
127  void SetNRoomsX (uint16_t nroomx);
128 
134  void SetNRoomsY (uint16_t nroomy);
135 
140  Box GetBoundaries () const;
141 
146 
151 
155  uint16_t GetNFloors () const;
156 
160  uint16_t GetNRoomsX () const;
161 
165  uint16_t GetNRoomsY () const;
166 
174  bool IsInside (Vector position) const;
175 
184  uint16_t GetRoomX (Vector position) const;
185 
194  uint16_t GetRoomY (Vector position) const;
195 
202  uint16_t GetFloor (Vector position) const;
203 
204 
205 
206 
207 private:
208 
210 
215  uint16_t m_floors;
216  uint16_t m_roomsX;
217  uint16_t m_roomsY;
218 
219  uint32_t m_buildingId;
222 
223 };
224 
225 } // namespace ns3
226 
227 #endif /* BUILDING_H */
uint16_t GetNFloors() const
Definition: building.cc:201
void SetNRoomsY(uint16_t nroomy)
Definition: building.cc:175
ExtWallsType_t GetExtWallsType() const
Definition: building.cc:195
uint16_t m_roomsY
Definition: building.h:217
uint16_t GetRoomY(Vector position) const
Definition: building.cc:247
bool IsInside(Vector position) const
Definition: building.cc:219
a 3d vector
Definition: vector.h:31
uint16_t m_floors
number of floors, must be greater than 0, and 1 means only one floor (i.e., groundfloor) ...
Definition: building.h:215
a 3d box
Definition: box.h:33
virtual void DoDispose()
This method is called by Object::Dispose or by the object's destructor, whichever comes first...
Definition: building.cc:127
uint32_t m_buildingId
Definition: building.h:219
uint16_t GetNRoomsX() const
Definition: building.cc:207
BuildingType_t m_buildingType
Definition: building.h:220
void SetNFloors(uint16_t nfloors)
Definition: building.cc:161
void SetExtWallsType(Building::ExtWallsType_t t)
Definition: building.cc:154
static TypeId GetTypeId(void)
Definition: building.cc:41
Box m_buildingBounds
Definition: building.h:209
uint16_t m_roomsX
Definition: building.h:216
ExtWallsType_t m_externalWalls
Definition: building.h:221
uint16_t GetRoomX(Vector position) const
Definition: building.cc:226
Box GetBoundaries() const
Definition: building.cc:182
Building()
Create a zero-sized building located at coordinates (0.0,0.0,0.0) and with 1 floors and 1 room...
Definition: building.cc:115
uint16_t GetNRoomsY() const
Definition: building.cc:213
a 3d building block
Definition: building.h:37
void SetNRoomsX(uint16_t nroomx)
Definition: building.cc:168
virtual ~Building()
Destructor.
Definition: building.cc:121
a base class which provides memory management and object aggregation
Definition: object.h:63
uint32_t GetId(void) const
Definition: building.cc:133
uint16_t GetFloor(Vector position) const
Definition: building.cc:268
a unique identifier for an interface.
Definition: type-id.h:49
void SetBoundaries(Box box)
Set the boundaries of the building.
Definition: building.cc:140
BuildingType_t GetBuildingType() const
Definition: building.cc:189
void SetBuildingType(Building::BuildingType_t t)
Definition: building.cc:147