Buildings mobility model. More...

#include <buildings-mobility-model.h>

Inheritance diagram for ns3::BuildingsMobilityModel:

Collaboration diagram for ns3::BuildingsMobilityModel:

Public Member Functions
	BuildingsMobilityModel ()
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
	MobilityModel ()
virtual	~MobilityModel ()=0
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
	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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	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
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)
	This method returns the TypeId associated to ns3::BuildingsMobilityModel.

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

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.

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

Constructor & Destructor Documentation

ns3::BuildingsMobilityModel::BuildingsMobilityModel ( )

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

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

Member Function Documentation

void ns3::BuildingsMobilityModel::DoDispose ( void )

privatevirtual

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

References NS_LOG_FUNCTION.

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

privatevirtual

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

References ns3::ConstantVelocityHelper::GetCurrentPosition(), m_helper, NS_LOG_FUNCTION, and ns3::ConstantVelocityHelper::Update().

Here is the call graph for this function:

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

privatevirtual

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

References ns3::ConstantVelocityHelper::GetVelocity(), m_helper, and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

privatevirtual

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

References m_helper, NS_LOG_FUNCTION, and ns3::ConstantVelocityHelper::SetPosition().

Here is the call graph for this function:

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

Returns

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

References m_myBuilding, and NS_LOG_FUNCTION.

Referenced by ns3::BuildingsHelperOneTestCase::DoRun(), ns3::BuildingsPropagationLossModel::ExternalWallLoss(), ns3::OhBuildingsPropagationLossModel::GetLoss(), ns3::ItuR1238PropagationLossModel::GetLoss(), ns3::HybridBuildingsPropagationLossModel::GetLoss(), and ns3::SameRoomPositionAllocator::GetNext().

Here is the caller graph for this function:

uint8_t ns3::BuildingsMobilityModel::GetFloorNumber ( void )

Returns

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

References m_nFloor, and NS_LOG_FUNCTION.

Referenced by ns3::RandomRoomPositionAllocatorTestCase::DoRun(), ns3::BuildingsHelperOneTestCase::DoRun(), ns3::SameRoomPositionAllocatorTestCase::DoRun(), ns3::ItuR1238PropagationLossModel::GetLoss(), ns3::SameRoomPositionAllocator::GetNext(), and ns3::BuildingsPropagationLossModel::HeightLoss().

Here is the caller graph for this function:

uint8_t ns3::BuildingsMobilityModel::GetRoomNumberX ( void )

Returns

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

References m_roomX, and NS_LOG_FUNCTION.

Referenced by ns3::RandomRoomPositionAllocatorTestCase::DoRun(), ns3::BuildingsHelperOneTestCase::DoRun(), ns3::SameRoomPositionAllocatorTestCase::DoRun(), ns3::SameRoomPositionAllocator::GetNext(), and ns3::BuildingsPropagationLossModel::InternalWallsLoss().

Here is the caller graph for this function:

uint8_t ns3::BuildingsMobilityModel::GetRoomNumberY ( void )

Returns

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

References m_roomY, and NS_LOG_FUNCTION.

Referenced by ns3::RandomRoomPositionAllocatorTestCase::DoRun(), ns3::BuildingsHelperOneTestCase::DoRun(), ns3::SameRoomPositionAllocatorTestCase::DoRun(), ns3::SameRoomPositionAllocator::GetNext(), and ns3::BuildingsPropagationLossModel::InternalWallsLoss().

Here is the caller graph for this function:

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.
- Set with class: Vector3DValue
- Underlying type: Vector3D
- Flags: write read
Velocity: The current velocity of the mobility model.
- Set with class: Vector3DValue
- Underlying type: Vector3D
- Flags: read

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.

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

References ns3::TypeId::SetParent().

Here is the call graph for this 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 m_indoor, and NS_LOG_FUNCTION.

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

Here is the caller graph for this 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 m_indoor, and NS_LOG_FUNCTION.

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

Here is the caller graph for this 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