src/buildings/model/buildings-mobility-model.h
author Marco Miozzo <marco.miozzo@cttc.es>
Mon, 03 Jun 2013 17:01:52 +0200
changeset 10080 1b36e2276e15
parent 8769 292e9e8345cf
permissions -rw-r--r--
Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     1
/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     2
/*
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     3
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     4
 *
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     5
 * This program is free software; you can redistribute it and/or modify
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     6
 * it under the terms of the GNU General Public License version 2 as
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     7
 * published by the Free Software Foundation;
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     8
 *
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
     9
 * This program is distributed in the hope that it will be useful,
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    10
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    11
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    12
 * GNU General Public License for more details.
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    13
 *
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    14
 * You should have received a copy of the GNU General Public License
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    15
 * along with this program; if not, write to the Free Software
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    16
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    17
 *
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    18
 * Author: Marco Miozzo  <marco.miozzo@cttc.es>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    19
 * 
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    20
 */
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    21
#ifndef MOBILITY_BUILDING_INFO_H
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    22
#define MOBILITY_BUILDING_INFO_H
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    23
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    24
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    25
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    26
#include <ns3/simple-ref-count.h>
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    27
#include <ns3/ptr.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    28
#include <ns3/object.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    29
#include <ns3/box.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    30
#include <map>
8317
2ec35f16dc11 buildings does not depend on spectrum any more
Nicola Baldo <nbaldo@cttc.es>
parents: 8248
diff changeset
    31
#include <ns3/building.h>
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    32
#include <ns3/constant-velocity-helper.h>
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    33
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    34
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    35
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    36
namespace ns3 {
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    37
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    38
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    39
/**
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    40
 * \ingroup buildings
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    41
 * \brief mobility buildings information (to be used by mobility models)
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    42
 *
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    43
 * This model implements the managment of scenarios where users might be
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    44
 * either indoor (e.g., houses, offices, etc.) and outdoor.
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    45
 * 
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    46
 */
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    47
class MobilityBuildingInfo : public Object
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
    48
{
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    49
public:
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    50
  static TypeId GetTypeId (void);
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    51
  MobilityBuildingInfo ();
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    52
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    53
  MobilityBuildingInfo (Ptr<Building> building);
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    54
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    55
  /** 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    56
   * 
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    57
   * \return true if the MobilityBuildingInfo instance is indoor, false otherwise
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    58
   */
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    59
  bool IsIndoor (void);
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    60
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    61
  /** 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    62
   * 
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    63
   * \return true if the MobilityBuildingInfo instance is outdoor, false otherwise
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    64
   */
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    65
  bool IsOutdoor (void);
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    66
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    67
  /** 
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    68
   * Mark this MobilityBuildingInfo instance as indoor
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    69
   * 
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    70
   * \param building the building into which the MobilityBuildingInfo instance is located
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    71
   * \param nfloor the floor number 1...nFloors at which the  MobilityBuildingInfo instance is located
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    72
   * \param nroomx the X room number 1...nRoomsX at which the  MobilityBuildingInfo instance is located
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    73
   * \param nroomy the Y room number 1...nRoomsY at which the  MobilityBuildingInfo instance is located
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    74
   */
8338
ff32cd151f7c Add indoor nodes position consistence check in BuildingMobilityModel and update correspondent documentation
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8332
diff changeset
    75
  void SetIndoor (Ptr<Building> building, uint8_t nfloor, uint8_t nroomx, uint8_t nroomy);
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    76
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    77
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    78
  void SetIndoor (uint8_t nfloor, uint8_t nroomx, uint8_t nroomy);
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    79
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    80
  /** 
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
    81
   * Mark this MobilityBuildingInfo instance as outdoor
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    82
   * 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    83
   */
8769
292e9e8345cf remove BuildingsMobilityModel setters that don't allow consistency checking
Nicola Baldo <nbaldo@cttc.es>
parents: 8768
diff changeset
    84
  void SetOutdoor ();
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    85
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    86
  /** 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    87
   * 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    88
   * \return 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    89
   */
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    90
  uint8_t GetFloorNumber (void);
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    91
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    92
  /** 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    93
   * 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    94
   * \return 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    95
   */
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
    96
  uint8_t GetRoomNumberX (void);
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    97
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    98
  /** 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
    99
   * 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
   100
   * \return 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
   101
   */
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   102
  uint8_t GetRoomNumberY (void);
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   103
8768
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
   104
  /** 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
   105
   * 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
   106
   * \return 
e5607ee90a49 buildings module: consistent room & floor indexing
Nicola Baldo <nbaldo@cttc.es>
parents: 8556
diff changeset
   107
   */
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   108
  Ptr<Building> GetBuilding ();
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   109
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   110
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   111
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   112
private:
8556
f859539f5dd3 BuildingsMobilityModel instances automatically placed in appropriated Building
Nicola Baldo <nbaldo@cttc.es>
parents: 8338
diff changeset
   113
8332
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   114
  Ptr<Building> m_myBuilding;
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   115
  bool m_indoor;
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   116
  uint8_t m_nFloor;
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   117
  uint8_t m_roomX;
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   118
  uint8_t m_roomY;
c6d3c7862cfb Style fixed in buildings module
mmiozzo
parents: 8317
diff changeset
   119
8184
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   120
};
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   121
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   122
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   123
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   124
} // namespace ns3
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   125
b2d61f172004 Add Building class, BuildingMobilityModel and BuildingPropagationModel
Marco Miozzo <marco.miozzo@cttc.es>
parents:
diff changeset
   126
10080
1b36e2276e15 Move from BuildingsMobilityModel to BuildingMobilityInfo source, tests and examples
Marco Miozzo <marco.miozzo@cttc.es>
parents: 8769
diff changeset
   127
#endif // MOBILITY_BUILDING_INFO_H