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

Allocate positions from a deterministic list specified by the user. More...

#include <position-allocator.h>

+ Inheritance diagram for ns3::ListPositionAllocator:
+ Collaboration diagram for ns3::ListPositionAllocator:

Public Member Functions

 ListPositionAllocator ()
void Add (Vector v)
virtual 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::ListPositionAllocator.

Private Attributes

std::vector< Vector >
::const_iterator 
m_current
std::vector< Vectorm_positions

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 positions from a deterministic list specified by the user.

The first call to ListPositionAllocator::GetNext will return the first element of the list, the second call, the second element, and so on.

Definition at line 67 of file position-allocator.h.

Constructor & Destructor Documentation

ns3::ListPositionAllocator::ListPositionAllocator ( )

Definition at line 62 of file position-allocator.cc.

Member Function Documentation

void ns3::ListPositionAllocator::Add ( Vector  v)
Parameters
vthe position to append at the end of the list of positions to return from GetNext.

Definition at line 66 of file position-allocator.cc.

References m_current, and m_positions.

Referenced by HwmpReactiveRegressionTest::CreateNodes(), WaypointMobilityModelViaHelper::DoRun(), main(), Experiment::Run(), NetAnimExperiment::Run(), and WifiInterferenceTestCase::WifiSimpleInterference().

+ Here is the caller graph for this function:

int64_t ns3::ListPositionAllocator::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.

This method must be implement in subclasses.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Implements ns3::PositionAllocator.

Definition at line 83 of file position-allocator.cc.

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

This method must be implement in subclasses.

Implements ns3::PositionAllocator.

Definition at line 72 of file position-allocator.cc.

References m_current, and m_positions.

TypeId ns3::ListPositionAllocator::GetTypeId ( void  )
static

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

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

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

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

Reimplemented from ns3::PositionAllocator.

Definition at line 54 of file position-allocator.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

std::vector<Vector>::const_iterator ns3::ListPositionAllocator::m_current
mutableprivate

Definition at line 81 of file position-allocator.h.

Referenced by Add(), and GetNext().

std::vector<Vector> ns3::ListPositionAllocator::m_positions
private

Definition at line 80 of file position-allocator.h.

Referenced by Add(), and GetNext().


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