A Discrete-Event Network Simulator
API
ns3::Building Class Reference

a 3d building block More...

#include "building.h"

+ Inheritance diagram for ns3::Building:
+ Collaboration diagram for ns3::Building:

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)
 Construct a simple building with 1 room and 1 floor. More...
 
 Building ()
 Create a zero-sized building located at coordinates (0.0,0.0,0.0) and with 1 floors and 1 room. More...
 
virtual ~Building ()
 Destructor. More...
 
virtual void DoDispose ()
 Destructor implementation. More...
 
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)
 Set the boundaries of the building. More...
 
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
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

Box m_buildingBounds
 
uint32_t m_buildingId
 
BuildingType_t m_buildingType
 
ExtWallsType_t m_externalWalls
 
uint16_t m_floors
 number of floors, must be greater than 0, and 1 means only one floor (i.e., groundfloor) More...
 
uint16_t m_roomsX
 
uint16_t m_roomsY
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

a 3d building block

Introspection did not find any typical Config paths.


Attributes

  • NRoomsX: The number of rooms in the X axis.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 1
    • Flags: construct write read
  • NRoomsY: The number of rooms in the Y axis.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 1
    • Flags: construct write read
  • NFloors: The number of floors of this building.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 1
    • Flags: construct write read
  • Id: The id (unique integer) of this Building.
  • Boundaries: The boundaries of this Building as a value of type ns3::Box
    • Set with class: BoxValue
    • Underlying type: Box
    • Initial value: 0|0|0|0|0|0
    • Flags: construct write read
  • Type: The type of building
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: Residential
    • Flags: construct write read
  • ExternalWallsType: The type of material of which the external walls are made
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: ConcreteWithWindows
    • Flags: construct write read

No TraceSources are defined for this type.
Size of this type is 104 bytes (on a 64-bit architecture).

Definition at line 37 of file building.h.

Member Enumeration Documentation

Enumerator
Residential 
Office 
Commercial 

Definition at line 46 of file building.h.

Enumerator
Wood 
ConcreteWithWindows 
ConcreteWithoutWindows 
StoneBlocks 

Definition at line 50 of file building.h.

Constructor & Destructor Documentation

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.

Parameters
xMinx coordinates of left boundary.
xMaxx coordinates of right boundary.
yMiny coordinates of bottom boundary.
yMaxy coordinates of top boundary.
zMinz coordinates of down boundary.
zMaxz 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(), m_buildingId, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

ns3::Building::~Building ( )
virtual

Destructor.

Definition at line 120 of file building.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::Building::DoDispose ( void  )
virtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden 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
Returns
the boundaries of the building

Definition at line 181 of file building.cc.

References m_buildingBounds, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Building::BuildingType_t ns3::Building::GetBuildingType ( ) const
Returns
the type of building

Definition at line 188 of file building.cc.

References m_buildingType.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

Building::ExtWallsType_t ns3::Building::GetExtWallsType ( ) const
Returns
the type of external walls of the building

Definition at line 194 of file building.cc.

References m_externalWalls.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

uint16_t ns3::Building::GetFloor ( Vector  position) const
Parameters
positiona position inside the building
Returns
the floor where the position falls

Definition at line 267 of file building.cc.

References IsInside(), m_buildingBounds, m_floors, sample-rng-plot::n, NS_ASSERT, NS_LOG_LOGIC(), ns3::Box::zMax, and ns3::Box::zMin.

+ Here is the call graph for this function:

uint32_t ns3::Building::GetId ( void  ) const
Returns
the unique id of this Building. This unique id happens to be also the index of the Building into the BuildingList.

Definition at line 132 of file building.cc.

References m_buildingId, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

uint16_t ns3::Building::GetNFloors ( ) const
Returns
the number of floors of the building

Definition at line 200 of file building.cc.

References m_floors.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

uint16_t ns3::Building::GetNRoomsX ( ) const
Returns
the number of rooms along the x-axis of the building

Definition at line 206 of file building.cc.

References m_roomsX.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

uint16_t ns3::Building::GetNRoomsY ( ) const
Returns
the number of rooms along the y-axis

Definition at line 212 of file building.cc.

References m_roomsY.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

uint16_t ns3::Building::GetRoomX ( Vector  position) const
Parameters
positiona position inside the building
Returns
the number of the room along the X axis where the position falls

Definition at line 225 of file building.cc.

References IsInside(), m_buildingBounds, m_roomsX, sample-rng-plot::n, NS_ASSERT, NS_LOG_LOGIC(), sample-rng-plot::x, ns3::Box::xMax, and ns3::Box::xMin.

+ Here is the call graph for this function:

uint16_t ns3::Building::GetRoomY ( Vector  position) const
Parameters
positiona position inside the building
Returns
the number of the room along the Y axis where the position falls

Definition at line 246 of file building.cc.

References IsInside(), m_buildingBounds, m_roomsY, sample-rng-plot::n, NS_ASSERT, NS_LOG_LOGIC(), ns3::Box::yMax, and ns3::Box::yMin.

+ Here is the call graph for this function:

bool ns3::Building::IsInside ( Vector  position) const
Parameters
positionsome position
Returns
true if the position fall inside the building, false otherwise

Definition at line 218 of file building.cc.

References ns3::Box::IsInside(), and m_buildingBounds.

Referenced by GetFloor(), GetRoomX(), and GetRoomY().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::Building::SetBoundaries ( Box  box)

Set the boundaries of the building.

Parameters
boxthe Box defining the boundaries of the building

Definition at line 139 of file building.cc.

References m_buildingBounds, and NS_LOG_FUNCTION.

Referenced by BuildingsPathlossTestCase::DoRun(), BuildingsShadowingTestCase::DoRun(), RandomRoomPositionAllocatorTestCase::DoRun(), BuildingsHelperOneTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

void ns3::Building::SetBuildingType ( Building::BuildingType_t  t)
Parameters
tthe 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 m_buildingType, and NS_LOG_FUNCTION.

Referenced by BuildingsPathlossTestCase::DoRun(), BuildingsShadowingTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

void ns3::Building::SetExtWallsType ( Building::ExtWallsType_t  t)
Parameters
tthe 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 m_externalWalls, and NS_LOG_FUNCTION.

Referenced by BuildingsPathlossTestCase::DoRun(), BuildingsShadowingTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

void ns3::Building::SetNFloors ( uint16_t  nfloors)
Parameters
nfloorsthe 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.

Referenced by BuildingsPathlossTestCase::DoRun(), BuildingsShadowingTestCase::DoRun(), RandomRoomPositionAllocatorTestCase::DoRun(), BuildingsHelperOneTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

void ns3::Building::SetNRoomsX ( uint16_t  nroomx)
Parameters
nroomxthe 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 m_roomsX, and NS_LOG_FUNCTION.

Referenced by RandomRoomPositionAllocatorTestCase::DoRun(), BuildingsHelperOneTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

void ns3::Building::SetNRoomsY ( uint16_t  nroomy)
Parameters
nroomythe 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 m_roomsY, and NS_LOG_FUNCTION.

Referenced by RandomRoomPositionAllocatorTestCase::DoRun(), BuildingsHelperOneTestCase::DoRun(), SameRoomPositionAllocatorTestCase::DoRun(), and GetTypeId().

+ Here is the caller graph for this function:

Member Data Documentation

Box ns3::Building::m_buildingBounds
private

Definition at line 209 of file building.h.

Referenced by GetBoundaries(), GetFloor(), GetRoomX(), GetRoomY(), IsInside(), and SetBoundaries().

uint32_t ns3::Building::m_buildingId
private

Definition at line 219 of file building.h.

Referenced by Building(), and GetId().

BuildingType_t ns3::Building::m_buildingType
private

Definition at line 220 of file building.h.

Referenced by GetBuildingType(), and SetBuildingType().

ExtWallsType_t ns3::Building::m_externalWalls
private

Definition at line 221 of file building.h.

Referenced by GetExtWallsType(), and SetExtWallsType().

uint16_t ns3::Building::m_floors
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().

uint16_t ns3::Building::m_roomsX
private

Definition at line 216 of file building.h.

Referenced by GetNRoomsX(), GetRoomX(), and SetNRoomsX().

uint16_t ns3::Building::m_roomsY
private

Definition at line 217 of file building.h.

Referenced by GetNRoomsY(), GetRoomY(), and SetNRoomsY().


The documentation for this class was generated from the following files: