ns-3
ns3::BuildingsMobilityModel Class Reference

Buildings mobility model. More...

#include <buildings-mobility-model.h>

Inheritance diagram for ns3::BuildingsMobilityModel:
Collaboration diagram for ns3::BuildingsMobilityModel:

List of all members.

Public Member Functions

bool IsIndoor (void)
bool IsOutdoor (void)
void SetIndoor (Ptr< Building > building, uint8_t nfloor, uint8_t nroomx, uint8_t nroomy)
void SetOutdoor ()
uint8_t GetFloorNumber (void)
uint8_t GetRoomNumberX (void)
uint8_t GetRoomNumberY (void)
Ptr< BuildingGetBuilding ()
- Public Member Functions inherited from ns3::MobilityModel
Vector GetPosition (void) const
void SetPosition (const Vector &position)
Vector GetVelocity (void) const
double GetDistanceFrom (Ptr< const MobilityModel > position) const
double GetRelativeSpeed (Ptr< const MobilityModel > other) const
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::BuildingsMobilityModel.

Additional Inherited Members

- Protected Member Functions inherited from ns3::MobilityModel
void NotifyCourseChange (void) const
- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
 Object (const Object &o)

Detailed Description

Buildings mobility model.

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


Member Function Documentation

uint8_t ns3::BuildingsMobilityModel::GetFloorNumber ( void  )
uint8_t ns3::BuildingsMobilityModel::GetRoomNumberX ( void  )
Returns:

References NS_LOG_FUNCTION.

Referenced by ns3::SameRoomPositionAllocator::GetNext().

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

References NS_LOG_FUNCTION.

Referenced by ns3::SameRoomPositionAllocator::GetNext().

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

This method returns the TypeId associated to ns3::BuildingsMobilityModel.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/$ns3::MobilityModel/$ns3::BuildingsMobilityModel

No Attributes defined for this type.
Attributes defined in parent class ns3::MobilityModel:

  • Position: The current position of the mobility model.
  • Velocity: The current velocity of the mobility model.

No TraceSources defined for this type.
TraceSources defined in parent class ns3::MobilityModel:

  • CourseChange: The value of the position and/or velocity vector changed

Reimplemented from ns3::MobilityModel.

References ns3::TypeId::SetParent().

bool ns3::BuildingsMobilityModel::IsIndoor ( void  )
Returns:
true if the MobilityModel instance is indoor, false otherwise

References NS_LOG_FUNCTION.

bool ns3::BuildingsMobilityModel::IsOutdoor ( void  )
Returns:
true if the MobilityModel instance is outdoor, false otherwise

References NS_LOG_FUNCTION.

Referenced by ns3::OhBuildingsPropagationLossModel::GetLoss(), and ns3::HybridBuildingsPropagationLossModel::GetLoss().

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

Mark this MobilityModel instance as indoor

Parameters:
buildingthe building into which the MobilityModel instance is located
nfloorthe floor number 1...nFloors at which the MobilityModel instance is located
nroomxthe X room number 1...nRoomsX at which the MobilityModel instance is located
nroomythe Y room number 1...nRoomsY at which the MobilityModel instance is located

References ns3::Building::IsInside(), NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

void ns3::BuildingsMobilityModel::SetOutdoor ( void  )

Mark this MobilityModel instance as outdoor

References NS_LOG_FUNCTION.


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