A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Classes | Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
ns3::RandomRoomPositionAllocator Class Reference

#include <building-position-allocator.h>

+ Inheritance diagram for ns3::RandomRoomPositionAllocator:
+ Collaboration diagram for ns3::RandomRoomPositionAllocator:

Classes

struct  RoomInfo

Public Member Functions

 RandomRoomPositionAllocator ()
int64_t AssignStreams (int64_t stream)
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::RandomRoomPositionAllocator.

Private Attributes

Ptr< UniformRandomVariable > m_rand
 Provides uniform random variables.
std::vector< RoomInfo > m_roomListWithoutReplacement
bool m_withReplacement

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

Allocate each position by randomly chosing a room from the list of all buildings, and then randomly chosing a position inside the room. The selection of the room is always done without replacement.

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

Constructor & Destructor Documentation

ns3::RandomRoomPositionAllocator::RandomRoomPositionAllocator ( )

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

References m_rand.

Member Function Documentation

int64_t ns3::RandomRoomPositionAllocator::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
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

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

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

+ Here is the call graph for this function:

Vector ns3::RandomRoomPositionAllocator::GetNext ( void  ) const
virtual
Returns
the next chosen position.

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

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

References ns3::RandomRoomPositionAllocator::RoomInfo::b, ns3::BuildingList::Begin(), ns3::BuildingList::End(), ns3::RandomRoomPositionAllocator::RoomInfo::floor, ns3::ObjectBase::GetAttribute(), ns3::Building::GetId(), ns3::UniformRandomVariable::GetInteger(), ns3::BuildingList::GetNBuildings(), ns3::Building::GetNFloors(), ns3::Building::GetNRoomsX(), ns3::Building::GetNRoomsY(), ns3::UniformRandomVariable::GetValue(), m_rand, m_roomListWithoutReplacement, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_LOGIC, ns3::RandomRoomPositionAllocator::RoomInfo::roomx, ns3::RandomRoomPositionAllocator::RoomInfo::roomy, 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::RandomRoomPositionAllocator::GetTypeId ( void  )
static

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

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

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

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

Reimplemented from ns3::PositionAllocator.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

Ptr<UniformRandomVariable> ns3::RandomRoomPositionAllocator::m_rand
private

Provides uniform random variables.

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

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

std::vector<RoomInfo> ns3::RandomRoomPositionAllocator::m_roomListWithoutReplacement
mutableprivate

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

Referenced by GetNext().

bool ns3::RandomRoomPositionAllocator::m_withReplacement
private

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

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