ns3::SameRoomPositionAllocator Class Reference

#include <building-position-allocator.h>

Inheritance diagram for ns3::SameRoomPositionAllocator:

Collaboration diagram for ns3::SameRoomPositionAllocator:

Public Member Functions
	SameRoomPositionAllocator ()
	SameRoomPositionAllocator (NodeContainer c)
int64_t	AssignStreams (int64_t)
virtual Vector	GetNext (void) const
Public Member Functions inherited from ns3::PositionAllocator
	PositionAllocator ()
virtual	~PositionAllocator ()
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::SameRoomPositionAllocator.

Private Attributes
NodeContainer::Iterator	m_nodeIt
NodeContainer	m_nodes
Ptr< UniformRandomVariable >	m_rand
	Provides uniform random variables.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
virtual void	DoDispose (void)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

Detailed Description

Walks a given NodeContainer sequentially, and for each node allocate a new position randomly in the same room of that node

Definition at line 119 of file building-position-allocator.h.

Constructor & Destructor Documentation

ns3::SameRoomPositionAllocator::SameRoomPositionAllocator

(

)

Definition at line 196 of file building-position-allocator.cc.

References NS_FATAL_ERROR.

ns3::SameRoomPositionAllocator::SameRoomPositionAllocator

(

NodeContainer

c

)

Definition at line 202 of file building-position-allocator.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::Object::GetObject(), m_nodeIt, m_nodes, m_rand, ns3::BuildingsHelper::MakeConsistent(), and NS_ASSERT_MSG.

Here is the call graph for this function:

Member Function Documentation

int64_t ns3::SameRoomPositionAllocator::AssignStreams ( int64_t  stream )

virtual

Assign a fixed random variable stream number to the random variables used by this model. Return the number of streams (possibly zero) that have been assigned.

Parameters

stream

first stream index to use

Returns

the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

Definition at line 278 of file building-position-allocator.cc.

References m_rand, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

Vector ns3::SameRoomPositionAllocator::GetNext ( void  ) const

virtual

Returns

the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

Definition at line 229 of file building-position-allocator.cc.

References ns3::NodeContainer::Begin(), ns3::NodeContainer::End(), ns3::BuildingsMobilityModel::GetBuilding(), ns3::BuildingsMobilityModel::GetFloorNumber(), ns3::Building::GetId(), ns3::Object::GetObject(), ns3::BuildingsMobilityModel::GetRoomNumberX(), ns3::BuildingsMobilityModel::GetRoomNumberY(), ns3::UniformRandomVariable::GetValue(), m_nodeIt, m_nodes, m_rand, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, sample-rng-plot::x, ns3::Box::xMax, ns3::Box::xMin, ns3::Box::yMax, ns3::Box::yMin, ns3::Box::zMax, and ns3::Box::zMin.

Here is the call graph for this function:

TypeId ns3::SameRoomPositionAllocator::GetTypeId ( void  )

static

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

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

• /NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::SameRoomPositionAllocator

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

Reimplemented from ns3::PositionAllocator.

Definition at line 219 of file building-position-allocator.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

Member Data Documentation

NodeContainer::Iterator ns3::SameRoomPositionAllocator::m_nodeIt

mutableprivate

Definition at line 144 of file building-position-allocator.h.

Referenced by GetNext(), and SameRoomPositionAllocator().

NodeContainer ns3::SameRoomPositionAllocator::m_nodes

private

Definition at line 143 of file building-position-allocator.h.

Referenced by GetNext(), and SameRoomPositionAllocator().

Ptr<UniformRandomVariable> ns3::SameRoomPositionAllocator::m_rand

private

Provides uniform random variables.

Definition at line 147 of file building-position-allocator.h.

Referenced by AssignStreams(), GetNext(), and SameRoomPositionAllocator().

---

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

• src/buildings/helper/building-position-allocator.h
• doc/introspected-doxygen.h
• src/buildings/helper/building-position-allocator.cc