Buildings mobility model. More...

#include <buildings-mobility-model.h>

Inheritance diagram for ns3::BuildingsMobilityModel:

Public Member Functions
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)

void	SetOutdoor ()

Public Member Functions inherited from ns3::MobilityModel
int64_t	AssignStreams (int64_t stream)

double	GetDistanceFrom (Ptr< const MobilityModel > position) const

Vector	GetPosition (void) const

double	GetRelativeSpeed (Ptr< const MobilityModel > other) const

Vector	GetVelocity (void) const

void	SetPosition (const Vector &position)

Public Member Functions inherited from ns3::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 (const SimpleRefCount &o)

uint32_t	GetReferenceCount (void) const

SimpleRefCount &	operator= (const SimpleRefCount &o)

void	Ref (void) const

void	Unref (void) const

Public Member Functions inherited from ns3::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::MobilityModel
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 Member Functions
virtual void	DoDispose (void)

virtual Vector	DoGetPosition (void) const

virtual Vector	DoGetVelocity (void) const

virtual void	DoSetPosition (const Vector &position)

Private Attributes
ConstantVelocityHelper	m_helper

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::MobilityModel
void	NotifyCourseChange (void) const

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)

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

Buildings mobility model.

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

Config Paths

ns3::BuildingsMobilityModel is accessible through the following paths with Config::Set and Config::Connect:

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

No Attributes are defined for this type.
No TraceSources are defined for this type.

TraceSources defined in parent class ns3::MobilityModel

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

Definition at line 47 of file buildings-mobility-model.h.

Member Function Documentation

void ns3::BuildingsMobilityModel::DoDispose ( void )

privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 57 of file buildings-mobility-model.cc.

References ns3::Object::DoDispose(), and NS_LOG_FUNCTION.

Vector ns3::BuildingsMobilityModel::DoGetPosition ( void ) const

privatevirtual

Returns: the current position.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 64 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

Vector ns3::BuildingsMobilityModel::DoGetVelocity ( void ) const

privatevirtual

Returns: the current velocity.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 77 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

void ns3::BuildingsMobilityModel::DoSetPosition ( const Vector & position )

privatevirtual

Parameters

position the position to set.

Concrete subclasses of this base class must implement this method.

Implements ns3::MobilityModel.

Definition at line 71 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

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

Returns

Definition at line 148 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

uint8_t ns3::BuildingsMobilityModel::GetFloorNumber ( void )

Returns

Definition at line 126 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

uint8_t ns3::BuildingsMobilityModel::GetRoomNumberX ( void )

Returns

Definition at line 133 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

uint8_t ns3::BuildingsMobilityModel::GetRoomNumberY ( void )

Returns

Definition at line 140 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

bool ns3::BuildingsMobilityModel::IsIndoor ( void )

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

Definition at line 84 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

bool ns3::BuildingsMobilityModel::IsOutdoor ( void )

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

Definition at line 91 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

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

Mark this MobilityModel instance as indoor

Parameters

building	the building into which the MobilityModel instance is located
nfloor	the floor number 1...nFloors at which the MobilityModel instance is located
nroomx	the X room number 1...nRoomsX at which the MobilityModel instance is located
nroomy	the Y room number 1...nRoomsY at which the MobilityModel instance is located

Definition at line 98 of file buildings-mobility-model.cc.

References NS_ASSERT, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

void ns3::BuildingsMobilityModel::SetOutdoor ( void )

Mark this MobilityModel instance as outdoor

Definition at line 119 of file buildings-mobility-model.cc.

References NS_LOG_FUNCTION.

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

src/buildings/model/buildings-mobility-model.h
src/buildings/model/buildings-mobility-model.cc

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

TraceSources defined in parent class ns3::MobilityModel

Member Function Documentation