A Discrete-Event Network Simulator
API
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)
 Add a position to the list of positions. More...
 
virtual int64_t AssignStreams (int64_t stream)
 Assign a fixed random variable stream number to the random variables used by this model. More...
 
virtual Vector GetNext (void) const
 
uint32_t GetSize (void) const
 Return the number of positions stored. More...
 
- Public Member Functions inherited from ns3::PositionAllocator
 PositionAllocator ()
 
virtual ~PositionAllocator ()
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising erros. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::PositionAllocator
static TypeId GetTypeId (void)
 Register this type with the TypeId system. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

Private Attributes

std::vector< Vector >::const_iterator m_current
 vector iterator More...
 
std::vector< Vector > m_positions
 vector of positions More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

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.

Config Paths

ns3::ListPositionAllocator is accessible through the following paths with Config::Set and Config::Connect:

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

No Attributes are defined for this type.
No TraceSources are defined for this type.
Size of this type is 64 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ ListPositionAllocator()

ns3::ListPositionAllocator::ListPositionAllocator ( )

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

Member Function Documentation

◆ Add()

void ns3::ListPositionAllocator::Add ( Vector  v)

Add a position to the list of positions.

Parameters
vthe position to append at the end of the list of positions to return from GetNext.

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

References m_current, and m_positions.

Referenced by TestInterBssConstantObssPdAlgo::AllocatePositions(), HwmpReactiveRegressionTest::CreateNodes(), WaveNetDeviceExample::CreateWaveNodes(), LteInterferenceHardFrTestCase::DoRun(), SpectrumIdealPhyTestCase::DoRun(), LteEnbAntennaTestCase::DoRun(), LteX2HandoverTestCase::DoRun(), LteCqiGenerationTestCase::DoRun(), LteInterferenceTestCase::DoRun(), LteRadioLinkFailureTestCase::DoRun(), LteIpv6RoutingTestCase::DoRun(), CarrierAggregationConfigTestCase::DoRun(), LteInterferenceStrictFrTestCase::DoRun(), LteUeMeasurementsTestCase::DoRun(), LteCellSelectionTestCase::DoRun(), LteX2HandoverMeasuresTestCase::DoRun(), LteHandoverTargetTestCase::DoRun(), LteCqiGenerationDlPowerControlTestCase::DoRun(), LteUplinkOpenLoopPowerControlTestCase::DoRun(), LteUplinkClosedLoopPowerControlAbsoluteModeTestCase::DoRun(), LteUplinkClosedLoopPowerControlAccumulatedModeTestCase::DoRun(), LteUeMeasurementsPiecewiseTestCase1::DoRun(), LteStrictFrAreaTestCase::DoRun(), LteSoftFrAreaTestCase::DoRun(), LteUeMeasurementsPiecewiseTestCase2::DoRun(), WaypointMobilityModelViaHelper::DoRun(), LteSoftFfrAreaTestCase::DoRun(), LteEnhancedFfrAreaTestCase::DoRun(), LteDistributedFfrAreaTestCase::DoRun(), LteUeMeasurementsHandoverTestCase::DoRun(), Bug730TestCase::DoRun(), BlockAckAggregationDisabledTest::DoRun(), QosFragmentationTestCase::DoRun(), Bug2222TestCase::DoRun(), Bug2843TestCase::DoRun(), NetAnimExperiment::Run(), Experiment::Run(), Bug2470TestCase::RunSubtest(), StaWifiMacScanningTestCase::Setup(), and WifiInterferenceTestCase::WifiSimpleInterference().

+ Here is the caller graph for this function:

◆ AssignStreams()

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 85 of file position-allocator.cc.

◆ GetNext()

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 74 of file position-allocator.cc.

References m_current, and m_positions.

◆ GetSize()

uint32_t ns3::ListPositionAllocator::GetSize ( void  ) const

Return the number of positions stored.

Note that this will not change based on calling GetNext(), as the number of positions is not altered by calling GetNext ().

Returns
the number of positions stored

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

References m_positions.

◆ GetTypeId()

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

Register this type with the TypeId system.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

◆ m_current

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

vector iterator

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

Referenced by Add(), and GetNext().

◆ m_positions

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

vector of positions

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

Referenced by Add(), GetNext(), and GetSize().


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