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

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. More...
 
Ptr< BuildingGetBuilding ()
 Get the building in which the MobilityBuildingInfo instance is located. More...
 
uint8_t GetFloorNumber (void)
 Get the floor number at which the MobilityBuildingInfo instance is located. More...
 
uint8_t GetRoomNumberX (void)
 Get the room number along x-axis at which the MobilityBuildingInfo instance is located. More...
 
uint8_t GetRoomNumberY (void)
 Get the room number along y-axis at which the MobilityBuildingInfo instance is located. More...
 
bool IsIndoor (void)
 Is indoor method. More...
 
NS_DEPRECATED bool IsOutdoor (void)
 Is outdoor function. More...
 
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. More...
 
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)
 Mark this MobilityBuildingInfo instance as indoor. More...
 
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...
 
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)
 Get the type ID. More...
 
- 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...
 

Protected Member Functions

virtual void DoInitialize ()
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor 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...
 

Private Attributes

Vector m_cachedPosition
 The node position cached after making its mobility model consistent. More...
 
bool m_indoor
 Node position (indoor/outdoor) ? More...
 
Ptr< Buildingm_myBuilding
 Building. More...
 
uint8_t m_nFloor
 The floor number at which the MobilityBuildingInfo instance is located. More...
 
uint8_t m_roomX
 The room number along x-axis at which the MobilityBuildingInfo instance is located. More...
 
uint8_t m_roomY
 The room number along y-axis at which the MobilityBuildingInfo instance is located. More...
 

Additional Inherited Members

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 72 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ MobilityBuildingInfo() [1/2]

ns3::MobilityBuildingInfo::MobilityBuildingInfo ( )

◆ MobilityBuildingInfo() [2/2]

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

Parameterized constructor.

Parameters
buildingThe building in which the MobilityBuildingInfo instance would be placed

Definition at line 67 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 ( void  )
protectedvirtual

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 48 of file mobility-building-info.cc.

References 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 171 of file mobility-building-info.cc.

References m_myBuilding, and NS_LOG_FUNCTION.

Referenced by BuildingsHelperOneTestCase::DoRun().

+ Here is the caller graph for this function:

◆ GetFloorNumber()

uint8_t ns3::MobilityBuildingInfo::GetFloorNumber ( void  )

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

Returns
The floor number

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

References m_nFloor, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ GetRoomNumberX()

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberX ( void  )

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

Returns
The room number

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

References m_roomX, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ GetRoomNumberY()

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberY ( void  )

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

Returns
The room number

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

References m_roomY, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::MobilityBuildingInfo::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ IsIndoor()

bool ns3::MobilityBuildingInfo::IsIndoor ( void  )

Is indoor method.

Returns
true if the MobilityBuildingInfo instance is indoor, false otherwise

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

References ns3::MobilityModel::GetPosition(), m_cachedPosition, m_indoor, MakeConsistent(), and NS_LOG_FUNCTION.

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

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ IsOutdoor()

bool ns3::MobilityBuildingInfo::IsOutdoor ( void  )

Is outdoor function.

Returns
true if the MobilityBuildingInfo instance is outdoor, false otherwise
Deprecated:
This method will go away in future release of ns-3. Calling IsInside () method of MobilityBuildingInfo class will suffice the need to determine if a node is inside or outside a building.

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

References IsIndoor(), 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
mmthe mobility model to be made consistent

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

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

Referenced by BuildingsPathlossTestCase::CreateMobilityModel(), BuildingsShadowingTestCase::CreateMobilityModel(), 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
buildingthe building into which the MobilityBuildingInfo instance is located
nfloorthe floor number 1...nFloors at which the MobilityBuildingInfo instance is located
nroomxthe X room number 1...nRoomsX at which the MobilityBuildingInfo instance is located
nroomythe Y room number 1...nRoomsY at which the MobilityBuildingInfo instance is located

Definition at line 101 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
nfloorthe floor number 1...nFloors at which the MobilityBuildingInfo instance is located
nroomxthe X room number 1...nRoomsX at which the MobilityBuildingInfo instance is located
nroomythe Y room number 1...nRoomsY at which the MobilityBuildingInfo instance is located

Definition at line 122 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.

+ Here is the call graph for this function:

◆ SetOutdoor()

void ns3::MobilityBuildingInfo::SetOutdoor ( void  )

Mark this MobilityBuildingInfo instance as outdoor.

Definition at line 142 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 161 of file mobility-building-info.h.

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

◆ m_indoor

bool ns3::MobilityBuildingInfo::m_indoor
private

Node position (indoor/outdoor) ?

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

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

◆ m_myBuilding

Ptr<Building> ns3::MobilityBuildingInfo::m_myBuilding
private

Building.

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

Referenced by GetBuilding(), and SetIndoor().

◆ m_nFloor

uint8_t ns3::MobilityBuildingInfo::m_nFloor
private

The floor number at which the MobilityBuildingInfo instance is located.

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

Referenced by GetFloorNumber(), MobilityBuildingInfo(), 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 159 of file mobility-building-info.h.

Referenced by GetRoomNumberX(), MobilityBuildingInfo(), 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 160 of file mobility-building-info.h.

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


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