A Discrete-Event Network Simulator
API
mobility-building-info.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 MOBILITY_BUILDING_INFO_H
22 #define MOBILITY_BUILDING_INFO_H
23 
24 
25 
26 #include <ns3/simple-ref-count.h>
27 #include <ns3/ptr.h>
28 #include <ns3/object.h>
29 #include <ns3/box.h>
30 #include <map>
31 #include <ns3/building.h>
32 #include <ns3/constant-velocity-helper.h>
33 #include <ns3/mobility-model.h>
34 
35 
36 
37 namespace ns3 {
38 
39 
49 {
50 public:
56  static TypeId GetTypeId (void);
58 
65 
71  bool IsIndoor (void);
72 
85  bool IsOutdoor (void);
86 
95  void SetIndoor (Ptr<Building> building, uint8_t nfloor, uint8_t nroomx, uint8_t nroomy);
96 
105  void SetIndoor (uint8_t nfloor, uint8_t nroomx, uint8_t nroomy);
106 
110  void SetOutdoor ();
111 
117  uint8_t GetFloorNumber (void);
118 
124  uint8_t GetRoomNumberX (void);
125 
131  uint8_t GetRoomNumberY (void);
132 
147 
148 protected:
149  // inherited from Object
150  virtual void DoInitialize ();
151 
152 
153 
154 private:
155 
157  bool m_indoor;
158  uint8_t m_nFloor;
159  uint8_t m_roomX;
160  uint8_t m_roomY;
162 
163 };
164 
165 
166 
167 } // namespace ns3
168 
169 
170 #endif // MOBILITY_BUILDING_INFO_H
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
void SetOutdoor()
Mark this MobilityBuildingInfo instance as outdoor.
uint8_t m_nFloor
The floor number at which the MobilityBuildingInfo instance is located.
uint8_t m_roomY
The room number along y-axis at which the MobilityBuildingInfo instance is located.
uint8_t m_roomX
The room number along x-axis at which the MobilityBuildingInfo instance is located.
uint8_t GetFloorNumber(void)
Get the floor number at which the MobilityBuildingInfo instance is located.
uint8_t GetRoomNumberX(void)
Get the room number along x-axis at which the MobilityBuildingInfo instance is located.
bool IsIndoor(void)
Is indoor method.
void SetIndoor(Ptr< Building > building, uint8_t nfloor, uint8_t nroomx, uint8_t nroomy)
Mark this MobilityBuildingInfo instance as indoor.
Vector m_cachedPosition
The node position cached after making its mobility model consistent.
Ptr< Building > m_myBuilding
Building.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void DoInitialize()
Initialize() implementation.
NS_DEPRECATED bool IsOutdoor(void)
Is outdoor function.
static TypeId GetTypeId(void)
Get the type ID.
#define NS_DEPRECATED
Mark a function as deprecated.
Definition: deprecated.h:60
Ptr< Building > GetBuilding()
Get the building in which the MobilityBuildingInfo instance is located.
mobility buildings information (to be used by mobility models)
A base class which provides memory management and object aggregation.
Definition: object.h:87
void MakeConsistent(Ptr< MobilityModel > mm)
Make the given mobility model consistent, by determining whether its position falls inside any of the...
bool m_indoor
Node position (indoor/outdoor) ?
a unique identifier for an interface.
Definition: type-id.h:58
uint8_t GetRoomNumberY(void)
Get the room number along y-axis at which the MobilityBuildingInfo instance is located.