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

#include "mobility-building-info.h"

Inheritance diagram for ns3::MobilityBuildingInfo:

Public Member Functions
	MobilityBuildingInfo ()

	MobilityBuildingInfo (Ptr< Building > building)

Ptr< Building >	GetBuilding ()

uint8_t	GetFloorNumber (void)

uint8_t	GetRoomNumberX (void)

uint8_t	GetRoomNumberY (void)

bool	IsIndoor (void)

bool	IsOutdoor (void)

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

void	SetIndoor (uint8_t nfloor, uint8_t nroomx, uint8_t nroomy)

void	SetOutdoor ()
	Mark this MobilityBuildingInfo instance as outdoor. More...

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...

SimpleRefCount &	operator= (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
bool	m_indoor

Ptr< Building >	m_myBuilding

uint8_t	m_nFloor

uint8_t	m_roomX

uint8_t	m_roomY

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

virtual void	DoDispose (void)
	Destructor implementation. 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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

mobility buildings information (to be used by mobility models)

Introspection did not find any typical Config paths.

This model implements the management of scenarios where users might be either indoor (e.g., houses, offices, etc.) and outdoor.

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

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

Constructor & Destructor Documentation

◆ MobilityBuildingInfo() [1/2]

ns3::MobilityBuildingInfo::MobilityBuildingInfo ( )

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

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

◆ MobilityBuildingInfo() [2/2]

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

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

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

Member Function Documentation

◆ GetBuilding()

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

Returns

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

References m_myBuilding, and NS_LOG_FUNCTION.

Referenced by BuildingsHelperOneTestCase::DoRun().

◆ GetFloorNumber()

uint8_t ns3::MobilityBuildingInfo::GetFloorNumber ( void )

Returns

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

References m_nFloor, and NS_LOG_FUNCTION.

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

◆ GetRoomNumberX()

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberX ( void )

Returns

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

References m_roomX, and NS_LOG_FUNCTION.

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

◆ GetRoomNumberY()

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberY ( void )

Returns

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

References m_roomY, and NS_LOG_FUNCTION.

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

◆ GetTypeId()

TypeId ns3::MobilityBuildingInfo::GetTypeId ( void )

static

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

References ns3::TypeId::SetParent().

◆ IsIndoor()

bool ns3::MobilityBuildingInfo::IsIndoor ( void )

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

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

References m_indoor, and NS_LOG_FUNCTION.

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

◆ IsOutdoor()

bool ns3::MobilityBuildingInfo::IsOutdoor ( void )

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

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

References m_indoor, and NS_LOG_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