mobility-building-info.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Marco Miozzo  <marco.miozzo@cttc.es>
 *
 */
#ifndef MOBILITY_BUILDING_INFO_H
#define MOBILITY_BUILDING_INFO_H
 
#include "building.h"
 
#include <ns3/box.h>
#include <ns3/constant-velocity-helper.h>
#include <ns3/mobility-model.h>
#include <ns3/object.h>
#include <ns3/ptr.h>
#include <ns3/simple-ref-count.h>
 
#include <map>
 
namespace ns3
{
 
/**
 * \ingroup buildings
 * \ingroup mobility
 
 * \brief mobility buildings information (to be used by mobility models)
 *
 * This model implements the management of scenarios where users might be
 * either indoor (e.g., houses, offices, etc.) and outdoor.
 *
 */
class MobilityBuildingInfo : public Object
{
  public:
    /**
     * \brief Get the type ID.
     *
     * \return the object TypeId
     */
    static TypeId GetTypeId();
    MobilityBuildingInfo();
 
    /**
     * \brief Parameterized constructor
     *
     * \param building The building in which the MobilityBuildingInfo instance would be placed
     */
    MobilityBuildingInfo(Ptr<Building> building);
 
    /**
     * \brief Is indoor method.
     *
     * \return true if the MobilityBuildingInfo instance is indoor, false otherwise
     */
    bool IsIndoor();
 
    /**
     * \brief Mark this MobilityBuildingInfo instance as indoor
     *
     * \param building the building into which the MobilityBuildingInfo instance is located
     * \param nfloor the floor number 1...nFloors at which the MobilityBuildingInfo instance
     * is located
     * \param nroomx the X room number 1...nRoomsX at which the MobilityBuildingInfo instance
     * is located
     * \param nroomy the Y room number 1...nRoomsY at which the MobilityBuildingInfo instance
     * is located
     */
    void SetIndoor(Ptr<Building> building, uint8_t nfloor, uint8_t nroomx, uint8_t nroomy);
 
    /**
     * \brief Mark this MobilityBuildingInfo instance as indoor
     *
     * \param nfloor the floor number 1...nFloors at which the MobilityBuildingInfo instance
     * is located
     * \param nroomx the X room number 1...nRoomsX at which the MobilityBuildingInfo instance
     * is located
     * \param nroomy the Y room number 1...nRoomsY at which the MobilityBuildingInfo instance
     * is located
     */
 
    void SetIndoor(uint8_t nfloor, uint8_t nroomx, uint8_t nroomy);
 
    /**
     * \brief Mark this MobilityBuildingInfo instance as outdoor
     */
    void SetOutdoor();
 
    /**
     * \brief Get the floor number at which the MobilityBuildingInfo instance is located
     *
     * \return The floor number
     */
    uint8_t GetFloorNumber();
 
    /**
     * \brief Get the room number along x-axis at which the MobilityBuildingInfo instance is located
     *
     * \return The room number
     */
    uint8_t GetRoomNumberX();
 
    /**
     * \brief Get the room number along y-axis at which the MobilityBuildingInfo instance is located
     *
     * \return The room number
     */
    uint8_t GetRoomNumberY();
 
    /**
     * \brief Get the building in which the MobilityBuildingInfo instance is located
     *
     * \return The building in which the MobilityBuildingInfo instance is located
     */
    Ptr<Building> GetBuilding();
    /**
     * \brief Make the given mobility model consistent, by determining whether
     * its position falls inside any of the building in BuildingList, and
     * updating accordingly the BuildingInfo aggregated with the MobilityModel.
     *
     * \param mm the mobility model to be made consistent
     */
    void MakeConsistent(Ptr<MobilityModel> mm);
 
  protected:
    // inherited from Object
    void DoInitialize() override;
 
  private:
    Ptr<Building> m_myBuilding; ///< Building
    bool m_indoor;              ///< Node position (indoor/outdoor) ?
    uint8_t m_nFloor; ///< The floor number 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 m_roomY; ///< The room number along y-axis at which the MobilityBuildingInfo instance is
                     ///< located
    Vector
        m_cachedPosition; ///< The node position cached after making its mobility model consistent
};
 
} // namespace ns3
 
#endif // MOBILITY_BUILDING_INFO_H