A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::RandomBuildingPositionAllocator Class Reference

#include <building-position-allocator.h>

+ Inheritance diagram for ns3::RandomBuildingPositionAllocator:
+ Collaboration diagram for ns3::RandomBuildingPositionAllocator:

Public Member Functions

 RandomBuildingPositionAllocator ()
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
SimpleRefCountoperator= (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::RandomBuildingPositionAllocator.

Private Attributes

std::vector< Ptr< Building > > m_buildingListWithoutReplacement
Ptr< UniformRandomVariablem_rand
 Provides uniform random variables.
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 building from the list of all buildings, and then randomly chosing a position inside the building.

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

Constructor & Destructor Documentation

ns3::RandomBuildingPositionAllocator::RandomBuildingPositionAllocator ( )

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

References m_rand.

Member Function Documentation

int64_t ns3::RandomBuildingPositionAllocator::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 99 of file building-position-allocator.cc.

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

+ Here is the call graph for this function:

Vector ns3::RandomBuildingPositionAllocator::GetNext ( void  ) const
virtual
TypeId ns3::RandomBuildingPositionAllocator::GetTypeId ( void  )
static

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

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

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

Attributes defined for this type:

  • WithReplacement: If true, the building will be randomly selected with replacement. If false, no replacement will occur, until the list of buildings to select becomes empty, at which point it will be filled again with the list of all buildings.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::PositionAllocator.

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

References m_withReplacement, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

std::vector< Ptr<Building> > ns3::RandomBuildingPositionAllocator::m_buildingListWithoutReplacement
mutableprivate

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

Referenced by GetNext().

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

Provides uniform random variables.

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

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

bool ns3::RandomBuildingPositionAllocator::m_withReplacement
private

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

Referenced by GetNext(), and GetTypeId().


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