a 3d building block More...
#include <building.h>
Public Types | |
enum | BuildingType_t { Residential, Office, Commercial } |
enum | ExtWallsType_t { Wood, ConcreteWithWindows, ConcreteWithoutWindows, StoneBlocks } |
Public Member Functions | |
Building (double xMin, double xMax, double yMin, double yMax, double zMin, double zMax) | |
Building () | |
virtual | ~Building () |
virtual void | DoDispose () |
Box | GetBoundaries () const |
BuildingType_t | GetBuildingType () const |
ExtWallsType_t | GetExtWallsType () const |
uint16_t | GetFloor (Vector position) const |
uint32_t | GetId (void) const |
uint16_t | GetNFloors () const |
uint16_t | GetNRoomsX () const |
uint16_t | GetNRoomsY () const |
uint16_t | GetRoomX (Vector position) const |
uint16_t | GetRoomY (Vector position) const |
bool | IsInside (Vector position) const |
void | SetBoundaries (Box box) |
void | SetBuildingType (Building::BuildingType_t t) |
void | SetExtWallsType (Building::ExtWallsType_t t) |
void | SetNFloors (uint16_t nfloors) |
void | SetNRoomsX (uint16_t nroomx) |
void | SetNRoomsY (uint16_t nroomy) |
Public Member Functions inherited from ns3::Object | |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
AggregateIterator | GetAggregateIterator (void) const |
virtual TypeId | GetInstanceTypeId (void) const |
template<typename T > | |
Ptr< T > | GetObject (void) const |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
void | Initialize (void) |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount (const SimpleRefCount &o) | |
uint32_t | GetReferenceCount (void) const |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
void | Ref (void) const |
void | Unref (void) const |
Public Member Functions inherited from ns3::ObjectBase | |
void | GetAttribute (std::string name, AttributeValue &value) const |
bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
void | SetAttribute (std::string name, const AttributeValue &value) |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId (void) |
Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
static void | Cleanup (void) |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId (void) |
Private Attributes | |
Box | m_buildingBounds |
uint32_t | m_buildingId |
BuildingType_t | m_buildingType |
ExtWallsType_t | m_externalWalls |
uint16_t | m_floors |
uint16_t | m_roomsX |
uint16_t | m_roomsY |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
virtual void | DoInitialize (void) |
virtual void | NotifyNewAggregate (void) |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
a 3d building block
Doxygen introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Definition at line 37 of file building.h.
ns3::Building::Building | ( | double | xMin, |
double | xMax, | ||
double | yMin, | ||
double | yMax, | ||
double | zMin, | ||
double | zMax | ||
) |
Construct a simple building with 1 room and 1 floor
xMin | x coordinates of left boundary. |
xMax | x coordinates of right boundary. |
yMin | y coordinates of bottom boundary. |
yMax | y coordinates of top boundary. |
zMin | z coordinates of down boundary. |
zMax | z coordinates of up boundary. |
Definition at line 84 of file building.cc.
References NS_FATAL_ERROR.
ns3::Building::Building | ( | ) |
Create a zero-sized building located at coordinates (0.0,0.0,0.0) and with 1 floors and 1 room.
Definition at line 114 of file building.cc.
References ns3::BuildingList::Add(), and NS_LOG_FUNCTION.
|
virtual |
|
virtual |
This method is called by Object::Dispose or by the object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.
It is safe to call GetObject from within this method.
Reimplemented from ns3::Object.
Definition at line 126 of file building.cc.
References NS_LOG_FUNCTION.
Box ns3::Building::GetBoundaries | ( | ) | const |
Definition at line 181 of file building.cc.
References NS_LOG_FUNCTION.
Building::BuildingType_t ns3::Building::GetBuildingType | ( | ) | const |
Definition at line 188 of file building.cc.
Building::ExtWallsType_t ns3::Building::GetExtWallsType | ( | ) | const |
Definition at line 194 of file building.cc.
uint16_t ns3::Building::GetFloor | ( | Vector | position | ) | const |
position | a position inside the building |
Definition at line 267 of file building.cc.
References IsInside(), m_floors, NS_ASSERT, NS_LOG_LOGIC, and ns3::Vector3D::z.
uint32_t ns3::Building::GetId | ( | void | ) | const |
Definition at line 132 of file building.cc.
References NS_LOG_FUNCTION.
uint16_t ns3::Building::GetNFloors | ( | ) | const |
Definition at line 200 of file building.cc.
References m_floors.
uint16_t ns3::Building::GetNRoomsX | ( | ) | const |
Definition at line 206 of file building.cc.
uint16_t ns3::Building::GetNRoomsY | ( | ) | const |
Definition at line 212 of file building.cc.
uint16_t ns3::Building::GetRoomX | ( | Vector | position | ) | const |
position | a position inside the building |
Definition at line 225 of file building.cc.
References IsInside(), NS_ASSERT, NS_LOG_LOGIC, and ns3::Vector3D::x.
uint16_t ns3::Building::GetRoomY | ( | Vector | position | ) | const |
position | a position inside the building |
Definition at line 246 of file building.cc.
References IsInside(), NS_ASSERT, NS_LOG_LOGIC, and ns3::Vector3D::y.
bool ns3::Building::IsInside | ( | Vector | position | ) | const |
position | some position |
Definition at line 218 of file building.cc.
References ns3::Box::IsInside().
Referenced by GetFloor(), GetRoomX(), and GetRoomY().
void ns3::Building::SetBoundaries | ( | Box | box | ) |
Set the boundaries of the building
box | the Box defining the boundaries of the building |
Definition at line 139 of file building.cc.
References NS_LOG_FUNCTION.
void ns3::Building::SetBuildingType | ( | Building::BuildingType_t | t | ) |
t | the type of building (i.e., Residential, Office, Commercial) |
This method allows to set building type (default is Residential)
Definition at line 146 of file building.cc.
References NS_LOG_FUNCTION.
void ns3::Building::SetExtWallsType | ( | Building::ExtWallsType_t | t | ) |
t | the type of external walls (i.e., Wood, ConcreteWithWindows, ConcreteWithoutWindows and StoneBlocks), used for evaluating the loss due to the penetration of external walls in outdoor <-> indoor comm. |
This method allows to set external walls type (default is Residential)
Definition at line 153 of file building.cc.
References NS_LOG_FUNCTION.
void ns3::Building::SetNFloors | ( | uint16_t | nfloors | ) |
nfloors | the number of floors in the building |
This method allows to set the number of floors in the building (default is 1)
Definition at line 160 of file building.cc.
References m_floors, and NS_LOG_FUNCTION.
void ns3::Building::SetNRoomsX | ( | uint16_t | nroomx | ) |
nroomx | the number of rooms along the x axis |
This method allows to set the number of rooms along the x-axis
Definition at line 167 of file building.cc.
References NS_LOG_FUNCTION.
void ns3::Building::SetNRoomsY | ( | uint16_t | nroomy | ) |
nroomy | the number of floors in the building |
This method allows to set the number of rooms along the y-axis
Definition at line 174 of file building.cc.
References NS_LOG_FUNCTION.
|
private |
number of floors, must be greater than 0, and 1 means only one floor (i.e., groundfloor)
Definition at line 215 of file building.h.
Referenced by GetFloor(), GetNFloors(), and SetNFloors().