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)

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 ()

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

virtual void	DoDispose (void)
	This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...

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

mobility buildings information (to be used by mobility models)

Doxygen introspection did not find any typical Config paths.

This model implements the managment 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.

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

Constructor & Destructor Documentation

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.

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

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(), and ns3::SameRoomPositionAllocator::GetNext().

Here is the caller graph for this function:

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(), SameRoomPositionAllocatorTestCase::DoRun(), and ns3::SameRoomPositionAllocator::GetNext().

Here is the caller graph for this function:

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(), SameRoomPositionAllocatorTestCase::DoRun(), and ns3::SameRoomPositionAllocator::GetNext().

Here is the caller graph for this function:

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(), SameRoomPositionAllocatorTestCase::DoRun(), and ns3::SameRoomPositionAllocator::GetNext().

Here is the caller graph for this function:

TypeId ns3::MobilityBuildingInfo::GetTypeId ( void )

static

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

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

Here is the caller graph for this function:

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.

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