building.cc

Go to the documentation of this file.

/*
 * Copyright (c) 2011 Centre Tecnologic de Telecomunicacions de Catalunya (CTTC)
 *
 * SPDX-License-Identifier: GPL-2.0-only
 *
 * Authors: Marco Miozzo  <marco.miozzo@cttc.es>
 *          Nicola Baldo <nbaldo@cttc.es>
 *
 */
 
#include "building.h"
 
#include "building-list.h"
 
#include <ns3/assert.h>
#include <ns3/enum.h>
#include <ns3/log.h>
#include <ns3/uinteger.h>
 
#include <cmath>
 
namespace ns3
{
 
NS_LOG_COMPONENT_DEFINE("Building");
 
NS_OBJECT_ENSURE_REGISTERED(Building);
 
TypeId
Building::GetTypeId()
{
    static TypeId tid =
        TypeId("ns3::Building")
            .SetParent<Object>()
            .AddConstructor<Building>()
            .SetGroupName("Buildings")
            .AddAttribute("NRoomsX",
                          "The number of rooms in the X axis.",
                          UintegerValue(1),
                          MakeUintegerAccessor(&Building::GetNRoomsX, &Building::SetNRoomsX),
                          MakeUintegerChecker<uint32_t>())
            .AddAttribute("NRoomsY",
                          "The number of rooms in the Y axis.",
                          UintegerValue(1),
                          MakeUintegerAccessor(&Building::GetNRoomsY, &Building::SetNRoomsY),
                          MakeUintegerChecker<uint32_t>())
            .AddAttribute("NFloors",
                          "The number of floors of this building.",
                          UintegerValue(1),
                          MakeUintegerAccessor(&Building::GetNFloors, &Building::SetNFloors),
                          MakeUintegerChecker<uint32_t>())
            .AddAttribute("Id",
                          "The id (unique integer) of this Building.",
                          UintegerValue(0),
                          MakeUintegerAccessor(&Building::GetId),
                          MakeUintegerChecker<uint32_t>())
            .AddAttribute("Boundaries",
                          "The boundaries of this Building as a value of type ns3::Box",
                          BoxValue(Box()),
                          MakeBoxAccessor(&Building::GetBoundaries, &Building::SetBoundaries),
                          MakeBoxChecker())
            .AddAttribute("Type",
                          "The type of building",
                          EnumValue(Building::Residential),
                          MakeEnumAccessor<BuildingType_t>(&Building::GetBuildingType,
                                                           &Building::SetBuildingType),
                          MakeEnumChecker(Building::Residential,
                                          "Residential",
                                          Building::Office,
                                          "Office",
                                          Building::Commercial,
                                          "Commercial"))
            .AddAttribute("ExternalWallsType",
                          "The type of material of which the external walls are made",
                          EnumValue(Building::ConcreteWithWindows),
                          MakeEnumAccessor<ExtWallsType_t>(&Building::GetExtWallsType,
                                                           &Building::SetExtWallsType),
                          MakeEnumChecker(Building::Wood,
                                          "Wood",
                                          Building::ConcreteWithWindows,
                                          "ConcreteWithWindows",
                                          Building::ConcreteWithoutWindows,
                                          "ConcreteWithoutWindows",
                                          Building::StoneBlocks,
                                          "StoneBlocks"));
    return tid;
}
 
Building::Building(double xMin, double xMax, double yMin, double yMax, double zMin, double zMax)
{
    NS_FATAL_ERROR(std::endl
                   << "this function is not supported any more:" << std::endl
                   << " Building::Building (double xMin, double xMax, double yMin, " << std::endl
                   << "                     double yMax, double zMin, double zMax)\n"
                   << std::endl
                   << "so you can't do any more stuff like:" << std::endl
                   << "Ptr<Building> b = CreateObject<Building> (" << xMin << ", " << xMax << ", "
                   << yMin << ", " << yMax << ", " << zMin << ", " << zMax << ")\n"
                   << std::endl
                   << "Please use instead something like this:" << std::endl
                   << " Ptr<Building> b = CreateObject<Building> ();" << std::endl
                   << " b->SetBoundaries (Box (" << xMin << ", " << xMax << ", " << yMin << ", "
                   << yMax << ", " << zMin << ", " << zMax << "));" << std::endl
                   << std::endl);
}
 
Building::Building()
{
    NS_LOG_FUNCTION(this);
    m_buildingId = BuildingList::Add(this);
}
 
Building::~Building()
{
    NS_LOG_FUNCTION(this);
}
 
void
Building::DoDispose()
{
    NS_LOG_FUNCTION(this);
}
 
uint32_t
Building::GetId() const
{
    NS_LOG_FUNCTION(this);
    return m_buildingId;
}
 
void
Building::SetBoundaries(Box boundaries)
{
    NS_LOG_FUNCTION(this << boundaries);
    m_buildingBounds = boundaries;
}
 
void
Building::SetBuildingType(Building::BuildingType_t t)
{
    NS_LOG_FUNCTION(this << t);
    m_buildingType = t;
}
 
void
Building::SetExtWallsType(Building::ExtWallsType_t t)
{
    NS_LOG_FUNCTION(this << t);
    m_externalWalls = t;
}
 
void
Building::SetNFloors(uint16_t nfloors)
{
    NS_LOG_FUNCTION(this << nfloors);
    m_floors = nfloors;
}
 
void
Building::SetNRoomsX(uint16_t nroomx)
{
    NS_LOG_FUNCTION(this << nroomx);
    m_roomsX = nroomx;
}
 
void
Building::SetNRoomsY(uint16_t nroomy)
{
    NS_LOG_FUNCTION(this << nroomy);
    m_roomsY = nroomy;
}
 
Box
Building::GetBoundaries() const
{
    NS_LOG_FUNCTION(this);
    return m_buildingBounds;
}
 
Building::BuildingType_t
Building::GetBuildingType() const
{
    return (m_buildingType);
}
 
Building::ExtWallsType_t
Building::GetExtWallsType() const
{
    return (m_externalWalls);
}
 
uint16_t
Building::GetNFloors() const
{
    return (m_floors);
}
 
uint16_t
Building::GetNRoomsX() const
{
    return (m_roomsX);
}
 
uint16_t
Building::GetNRoomsY() const
{
    return (m_roomsY);
}
 
bool
Building::IsInside(Vector position) const
{
    return m_buildingBounds.IsInside(position);
}
 
uint16_t
Building::GetRoomX(Vector position) const
{
    NS_ASSERT(IsInside(position));
    uint16_t n;
 
    if (position.x == m_buildingBounds.xMax)
    {
        n = m_roomsX;
    }
    else
    {
        double xLength = m_buildingBounds.xMax - m_buildingBounds.xMin;
        double x = position.x - m_buildingBounds.xMin;
        n = floor(m_roomsX * x / xLength) + 1;
        NS_LOG_LOGIC("xLength=" << xLength << ", x=" << x << ", m_roomsX=" << m_roomsX);
    }
    NS_LOG_LOGIC("RoomX: " << n);
    return n;
}
 
uint16_t
Building::GetRoomY(Vector position) const
{
    NS_ASSERT(IsInside(position));
    uint16_t n;
 
    if (position.y == m_buildingBounds.yMax)
    {
        n = m_roomsY;
    }
    else
    {
        double yLength = m_buildingBounds.yMax - m_buildingBounds.yMin;
        double y = position.y - m_buildingBounds.yMin;
        n = floor(m_roomsY * y / yLength) + 1;
        NS_LOG_LOGIC("yLength=" << yLength << ", y=" << y << ", m_roomsY=" << m_roomsY);
    }
    NS_LOG_LOGIC("RoomY: " << n);
    return n;
}
 
uint16_t
Building::GetFloor(Vector position) const
{
    NS_ASSERT(IsInside(position));
    uint16_t n;
 
    if (position.z == m_buildingBounds.zMax)
    {
        n = m_floors;
    }
    else
    {
        double zLength = m_buildingBounds.zMax - m_buildingBounds.zMin;
        double z = position.z - m_buildingBounds.zMin;
        n = floor(m_floors * z / zLength) + 1;
        NS_LOG_LOGIC("zLength=" << zLength << ", z=" << z << ", m_floors=" << m_floors);
    }
    NS_LOG_LOGIC("floor: " << n);
    return n;
}
 
bool
Building::IsIntersect(const Vector& l1, const Vector& l2) const
{
    return m_buildingBounds.IsIntersect(l1, l2);
}
 
} // namespace ns3