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 ()
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. 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 ()

virtual	~Object ()

void	AggregateObject (Ptr< Object > other)

void	Dispose (void)
	Run the DoDispose methods of this object and all the objects aggregated to it. More...

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)
	This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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

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)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. 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)

virtual void	DoInitialize (void)
	This method is called only once by Object::Initialize. More...

virtual void	NotifyNewAggregate (void)
	This method is invoked whenever two sets of objects are aggregated together. More...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

a 3d building block

Doxygen 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.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Flags: read
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: Residential|Office|Commercial
- 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: Wood|ConcreteWithWindows|ConcreteWithoutWindows|StoneBlocks
- Initial value: ConcreteWithWindows
- Flags: construct write read

No TraceSources are defined for this type.

Definition at line 37 of file building.h.

Member Enumeration Documentation

enum ns3::Building::BuildingType_t

Enumerator
Residential
Office
Commercial

Definition at line 46 of file building.h.

enum ns3::Building::ExtWallsType_t

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

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 85 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 115 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 121 of file building.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::Building::DoDispose ( void )

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 127 of file building.cc.

References NS_LOG_FUNCTION.

Box ns3::Building::GetBoundaries ( ) const

Returns: the boundaries of the building

Definition at line 182 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 189 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 195 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

position a position inside the building

Returns: the floor where the position falls

Definition at line 268 of file building.cc.

References IsInside(), m_buildingBounds, m_floors, NS_ASSERT, NS_LOG_LOGIC, ns3::Vector3D::z, 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 133 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 201 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 207 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 213 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

position a position inside the building

Returns: the number of the room along the X axis where the position falls

Definition at line 226 of file building.cc.

References IsInside(), m_buildingBounds, m_roomsX, NS_ASSERT, NS_LOG_LOGIC, sample-rng-plot::x, ns3::Vector3D::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

position a position inside the building

Returns: the number of the room along the Y axis where the position falls

Definition at line 247 of file building.cc.

References IsInside(), m_buildingBounds, m_roomsY, NS_ASSERT, NS_LOG_LOGIC, ns3::Vector3D::y, ns3::Box::yMax, and ns3::Box::yMin.

Here is the call graph for this function:

TypeId ns3::Building::GetTypeId ( void )

static

Definition at line 41 of file building.cc.

References Commercial, ConcreteWithoutWindows, ConcreteWithWindows, GetBoundaries(), GetBuildingType(), GetExtWallsType(), GetId(), GetNFloors(), GetNRoomsX(), GetNRoomsY(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), Office, Residential, SetBoundaries(), SetBuildingType(), SetExtWallsType(), SetNFloors(), SetNRoomsX(), SetNRoomsY(), ns3::TypeId::SetParent(), StoneBlocks, and Wood.

Here is the call graph for this function:

bool ns3::Building::IsInside ( Vector position ) const

Parameters

position some position

Returns: true if the position fall inside the building, false otherwise

Definition at line 219 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

box	the Box defining the boundaries of the building

Definition at line 140 of file building.cc.

References m_buildingBounds, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

void ns3::Building::SetBuildingType ( Building::BuildingType_t t )

Parameters

t	the type of building (i.e., Residential, Office, Commercial)

This method allows to set building type (default is Residential)

Definition at line 147 of file building.cc.

References m_buildingType, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and main().

Here is the caller graph for this function:

void ns3::Building::SetExtWallsType ( Building::ExtWallsType_t t )

Parameters

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 154 of file building.cc.

References m_externalWalls, and NS_LOG_FUNCTION.

Referenced by GetTypeId(), and main().

Here is the caller graph for this function: