A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
 
Ptr< BuildingGetBuilding ()
 
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)
 
void SetIndoor (uint8_t nfloor, uint8_t nroomx, uint8_t nroomy)
 
void SetOutdoor ()
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 
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)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 
 SimpleRefCount (const SimpleRefCount &o)
 
uint32_t GetReferenceCount (void) const
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 
void Ref (void) const
 
void Unref (void) const
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Attributes

bool m_indoor
 
Ptr< Buildingm_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)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

mobility buildings information (to be used by mobility models)

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

Doxygen introspection did not find any typical Config paths.
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.

uint8_t ns3::MobilityBuildingInfo::GetFloorNumber ( void  )
Returns

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

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

uint8_t ns3::MobilityBuildingInfo::GetRoomNumberY ( void  )
Returns

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

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

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

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

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

Mark this MobilityBuildingInfo instance as outdoor

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

References m_indoor, and NS_LOG_FUNCTION.

Member Data Documentation

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

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

Referenced by GetBuilding(), and SetIndoor().

uint8_t ns3::MobilityBuildingInfo::m_nFloor
private

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

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

uint8_t ns3::MobilityBuildingInfo::m_roomX
private

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

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

uint8_t ns3::MobilityBuildingInfo::m_roomY
private

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

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


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