mobility buildings information (to be used by mobility models) More...

#include "mobility-building-info.h"

Inheritance diagram for ns3::MobilityBuildingInfo:

Collaboration diagram for ns3::MobilityBuildingInfo:

Public Member Functions
	MobilityBuildingInfo ()

	MobilityBuildingInfo (Ptr< Building > building)
	Parameterized constructor.

Ptr< Building >	GetBuilding ()
	Get the building in which the MobilityBuildingInfo instance is located.

uint8_t	GetFloorNumber ()
	Get the floor number at which the MobilityBuildingInfo instance is located.

uint8_t	GetRoomNumberX ()
	Get the room number along x-axis at which the MobilityBuildingInfo instance is located.

uint8_t	GetRoomNumberY ()
	Get the room number along y-axis at which the MobilityBuildingInfo instance is located.

bool	IsIndoor ()
	Is indoor method.

void	MakeConsistent (Ptr< MobilityModel > mm)
	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.

void	SetIndoor (Ptr< Building > building, uint8_t nfloor, uint8_t nroomx, uint8_t nroomy)
	Mark this MobilityBuildingInfo instance as indoor.

void	SetIndoor (uint8_t nfloor, uint8_t nroomx, uint8_t nroomy)
	Mark this MobilityBuildingInfo instance as indoor.

void	SetOutdoor ()
	Mark this MobilityBuildingInfo instance as outdoor.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

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

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

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

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Protected Member Functions
void	DoInitialize () override
	Initialize() implementation.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Private Attributes
Vector	m_cachedPosition
	The node position cached after making its mobility model consistent.

bool	m_indoor
	Node position (indoor/outdoor) ?

Ptr< Building >	m_myBuilding
	Building.

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.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

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.

Definition at line 36 of file mobility-building-info.h.

Constructor & Destructor Documentation

◆ MobilityBuildingInfo() [1/2]

ns3::MobilityBuildingInfo::MobilityBuildingInfo ( )

Definition at line 46 of file mobility-building-info.cc.

References m_cachedPosition, m_indoor, m_nFloor, m_roomX, m_roomY, and NS_LOG_FUNCTION.

◆ MobilityBuildingInfo() [2/2]

ns3::MobilityBuildingInfo::MobilityBuildingInfo ( Ptr< Building > building )

Parameterized constructor.

Parameters

building The building in which the MobilityBuildingInfo instance would be placed

Definition at line 56 of file mobility-building-info.cc.

References m_indoor, m_nFloor, m_roomX, m_roomY, and NS_LOG_FUNCTION.

Member Function Documentation

◆ DoInitialize()

void ns3::MobilityBuildingInfo::DoInitialize ( )

overrideprotectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 39 of file mobility-building-info.cc.

References ns3::Object::GetObject(), MakeConsistent(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetBuilding()

Ptr< Building > ns3::MobilityBuildingInfo::GetBuilding ( )

Get the building in which the MobilityBuildingInfo instance is located.

Returns: The building in which the MobilityBuildingInfo instance is located

Definition at line 149 of file mobility-building-info.cc.

References m_myBuilding, and NS_LOG_FUNCTION.

◆ GetFloorNumber()

uint8_t ns3::MobilityBuildingInfo::GetFloorNumber ( )

Get the floor number at which the MobilityBuildingInfo instance is located.

Returns: The floor number

Definition at line 128 of file mobility-building-info.cc.

References m_nFloor, and NS_LOG_FUNCTION.

◆ GetRoomNumberX()

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberX ( )

Get the room number along x-axis at which the MobilityBuildingInfo instance is located.

Returns: The room number

Definition at line 135 of file mobility-building-info.cc.

References m_roomX, and NS_LOG_FUNCTION.

◆ GetRoomNumberY()

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberY ( )

Get the room number along y-axis at which the MobilityBuildingInfo instance is located.

Returns: The room number

Definition at line 142 of file mobility-building-info.cc.

References m_roomY, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::MobilityBuildingInfo::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 28 of file mobility-building-info.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ IsIndoor()

bool ns3::MobilityBuildingInfo::IsIndoor ( )

Is indoor method.

Returns: true if the MobilityBuildingInfo instance is indoor, false otherwise

Definition at line 67 of file mobility-building-info.cc.

References ns3::Object::GetObject(), m_cachedPosition, m_indoor, MakeConsistent(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ MakeConsistent()

void ns3::MobilityBuildingInfo::MakeConsistent ( Ptr< MobilityModel > mm )

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.

Parameters

mm	the mobility model to be made consistent

Definition at line 156 of file mobility-building-info.cc.

References ns3::BuildingList::Begin(), ns3::BuildingList::End(), m_cachedPosition, NS_ABORT_MSG_UNLESS, NS_LOG_LOGIC, SetIndoor(), and SetOutdoor().

Referenced by DoInitialize(), and IsIndoor().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetIndoor() [1/2]

void ns3::MobilityBuildingInfo::SetIndoor	(	Ptr< Building >	building,
		uint8_t	nfloor,
		uint8_t	nroomx,
		uint8_t	nroomy )

Mark this MobilityBuildingInfo instance as indoor.

Parameters

building	the building into which the MobilityBuildingInfo instance is located
nfloor	the floor number 1...nFloors at which the MobilityBuildingInfo instance is located
nroomx	the X room number 1...nRoomsX at which the MobilityBuildingInfo instance is located
nroomy	the Y room number 1...nRoomsY at which the MobilityBuildingInfo instance is located

Definition at line 82 of file mobility-building-info.cc.

References m_indoor, m_myBuilding, m_nFloor, m_roomX, m_roomY, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by MakeConsistent().

Here is the caller graph for this function:

◆ SetIndoor() [2/2]

void ns3::MobilityBuildingInfo::SetIndoor	(	uint8_t	nfloor,
		uint8_t	nroomx,
		uint8_t	nroomy )

Mark this MobilityBuildingInfo instance as indoor.

Parameters

nfloor	the floor number 1...nFloors at which the MobilityBuildingInfo instance is located
nroomx	the X room number 1...nRoomsX at which the MobilityBuildingInfo instance is located
nroomy	the Y room number 1...nRoomsY at which the MobilityBuildingInfo instance is located

Definition at line 103 of file mobility-building-info.cc.

References m_indoor, m_myBuilding, m_nFloor, m_roomX, m_roomY, NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ SetOutdoor()

void ns3::MobilityBuildingInfo::SetOutdoor ( )

Mark this MobilityBuildingInfo instance as outdoor.

Definition at line 121 of file mobility-building-info.cc.

References m_indoor, and NS_LOG_FUNCTION.

Referenced by MakeConsistent().

Here is the caller graph for this function:

Member Data Documentation

◆ m_cachedPosition

Vector ns3::MobilityBuildingInfo::m_cachedPosition

private

The node position cached after making its mobility model consistent.

Definition at line 141 of file mobility-building-info.h.

Referenced by MobilityBuildingInfo(), IsIndoor(), and MakeConsistent().

◆ m_indoor

bool ns3::MobilityBuildingInfo::m_indoor

private

Node position (indoor/outdoor) ?

Definition at line 134 of file mobility-building-info.h.

Referenced by MobilityBuildingInfo(), MobilityBuildingInfo(), IsIndoor(), SetIndoor(), SetIndoor(), and SetOutdoor().

◆ m_myBuilding

Ptr<Building> ns3::MobilityBuildingInfo::m_myBuilding

private

Building.

Definition at line 133 of file mobility-building-info.h.

Referenced by GetBuilding(), SetIndoor(), and SetIndoor().

◆ m_nFloor

uint8_t ns3::MobilityBuildingInfo::m_nFloor

private

The floor number at which the MobilityBuildingInfo instance is located.

Definition at line 135 of file mobility-building-info.h.

Referenced by MobilityBuildingInfo(), MobilityBuildingInfo(), GetFloorNumber(), SetIndoor(), and SetIndoor().

◆ m_roomX

uint8_t ns3::MobilityBuildingInfo::m_roomX

private

The room number along x-axis at which the MobilityBuildingInfo instance is located.

Definition at line 136 of file mobility-building-info.h.

Referenced by MobilityBuildingInfo(), MobilityBuildingInfo(), GetRoomNumberX(), SetIndoor(), and SetIndoor().

◆ m_roomY

uint8_t ns3::MobilityBuildingInfo::m_roomY

private

The room number along y-axis at which the MobilityBuildingInfo instance is located.

Definition at line 138 of file mobility-building-info.h.

Referenced by MobilityBuildingInfo(), MobilityBuildingInfo(), GetRoomNumberY(), SetIndoor(), and SetIndoor().

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

src/buildings/model/mobility-building-info.h
src/buildings/model/mobility-building-info.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MobilityBuildingInfo() [1/2]

◆ MobilityBuildingInfo() [2/2]

Member Function Documentation

◆ DoInitialize()

◆ GetBuilding()

◆ GetFloorNumber()

◆ GetRoomNumberX()

◆ GetRoomNumberY()

◆ GetTypeId()

◆ IsIndoor()

◆ MakeConsistent()

◆ SetIndoor() [1/2]

◆ SetIndoor() [2/2]

◆ SetOutdoor()

Member Data Documentation

◆ m_cachedPosition

◆ m_indoor

◆ m_myBuilding

◆ m_nFloor

◆ m_roomX

◆ m_roomY