A Discrete-Event Network Simulator
API
ns3::SequentialRandomVariable Class Reference

The Random Number Generator (RNG) that returns a pattern of sequential values. More...

#include "random-variable-stream.h"

+ Inheritance diagram for ns3::SequentialRandomVariable:
+ Collaboration diagram for ns3::SequentialRandomVariable:

Public Member Functions

 SequentialRandomVariable ()
 Creates a sequential RNG with the default values for the sequence parameters. More...
 
uint32_t GetConsecutive (void) const
 Get the number of times each distinct value of the sequence is repeated before incrementing to the next value. More...
 
Ptr< RandomVariableStreamGetIncrement (void) const
 Get the increment for the sequence. More...
 
virtual uint32_t GetInteger (void)
 Get the next random value as an integer drawn from the distribution. More...
 
double GetMax (void) const
 Get the limit of the sequence, which is (at least) one more than the last value of the sequence. More...
 
double GetMin (void) const
 Get the first value of the sequence. More...
 
virtual double GetValue (void)
 Get the next random value as a double drawn from the distribution. More...
 
- Public Member Functions inherited from ns3::RandomVariableStream
 RandomVariableStream ()
 Default constructor. More...
 
virtual ~RandomVariableStream ()
 Destructor. More...
 
int64_t GetStream (void) const
 Returns the stream number for the RngStream. More...
 
bool IsAntithetic (void) const
 Check if antithetic values will be generated. More...
 
void SetAntithetic (bool isAntithetic)
 Specify whether antithetic values should be generated. More...
 
void SetStream (int64_t stream)
 Specifies the stream number for the RngStream. More...
 
- 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. More...
 
- Static Public Member Functions inherited from ns3::RandomVariableStream
static TypeId GetTypeId (void)
 Register this type. 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

uint32_t m_consecutive
 The number of times each distinct value is repeated. More...
 
double m_current
 The current sequence value. More...
 
uint32_t m_currentConsecutive
 The number of times the current distinct value has been repeated. More...
 
Ptr< RandomVariableStreamm_increment
 Increment between distinct values. More...
 
bool m_isCurrentSet
 Indicates if the current sequence value has been properly initialized. More...
 
double m_max
 Strict upper bound on the sequence. More...
 
double m_min
 The first value of the sequence. More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::RandomVariableStream
RngStreamPeek (void) const
 Get the pointer to the underlying RngStream. More...
 
- 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

The Random Number Generator (RNG) that returns a pattern of sequential values.

This RNG has four configuration attributes:

  • An increment, Increment.
  • A consecutive repeat numer, Consecutive.
  • The minimum value, Min.
  • The maximum value, Max.

The RNG starts at the Min value. Each return value is repeated Consecutive times, before advancing by the Increment. When the Increment would cause the value to equal or exceed Max it is reset to Min first.

For example, if an instance is configured with:

Attribute Value
Min 2
Max 13
Increment 4
Consecutive 3

The sequence will repeat this pattern: 2 2 2 6 6 6 10 10 10.

Notice that Max will be a strict upper bound on the values: all values in the sequence will be less than Max.

Antithetic Values.

This RNG ignores the antithetic setting.

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstStart/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::BurstErrorModel/BurstSize/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::DhcpClient/Transactions/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OnTime/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OffTime/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanVelocity/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanDirection/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanPitch/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Speed/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Pause/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Direction/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Speed/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/Speed/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/Pause/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomRectanglePositionAllocator/X/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomRectanglePositionAllocator/Y/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/X/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/Y/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomBoxPositionAllocator/Z/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Theta/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Rho/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::OutdoorPositionAllocator/X/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::OutdoorPositionAllocator/Y/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::OutdoorPositionAllocator/Z/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::ArpL3Protocol/RequestJitter/$ns3::SequentialRandomVariable"
  • "/NodeList/[i]/$ns3::Icmpv6L4Protocol/SolicitationJitter/$ns3::SequentialRandomVariable"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::SequentialRandomVariable"
  • "/ChannelList/[i]/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::SequentialRandomVariable"

Attributes

  • Min: The first value of the sequence.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read
  • Max: One more than the last value of the sequence.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 0
    • Flags: construct write read
  • Increment: The sequence random variable increment.
  • Consecutive: The number of times each member of the sequence is repeated.
    • Set with class: ns3::IntegerValue
    • Underlying type: uint32_t 0:4294967295
    • Initial value: 1
    • Flags: construct write read

Attributes defined in parent class ns3::RandomVariableStream

  • Stream: The stream number for this RNG stream. -1 means "allocate a stream automatically". Note that if -1 is set, Get will return -1 so that it is not possible to know which value was automatically allocated.
    • Set with class: ns3::IntegerValue
    • Underlying type: int64_t -9223372036854775808:9223372036854775807
    • Initial value: -1
    • Flags: construct write read
  • Antithetic: Set this RNG stream to generate antithetic values
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: construct write read

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

Definition at line 399 of file random-variable-stream.h.

Constructor & Destructor Documentation

ns3::SequentialRandomVariable::SequentialRandomVariable ( )

Creates a sequential RNG with the default values for the sequence parameters.

Definition at line 295 of file random-variable-stream.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

uint32_t ns3::SequentialRandomVariable::GetConsecutive ( void  ) const

Get the number of times each distinct value of the sequence is repeated before incrementing to the next value.

Returns
The number of times each value is repeated.

Definition at line 328 of file random-variable-stream.cc.

References m_consecutive, and NS_LOG_FUNCTION.

Ptr< RandomVariableStream > ns3::SequentialRandomVariable::GetIncrement ( void  ) const

Get the increment for the sequence.

Returns
The increment between distinct values for the sequence.

Definition at line 321 of file random-variable-stream.cc.

References m_increment, and NS_LOG_FUNCTION.

uint32_t ns3::SequentialRandomVariable::GetInteger ( void  )
virtual

Get the next random value as an integer drawn from the distribution.

Returns
An integer random value.

Implements ns3::RandomVariableStream.

Definition at line 361 of file random-variable-stream.cc.

References GetValue(), NS_LOG_FUNCTION, and NS_OBJECT_ENSURE_REGISTERED.

+ Here is the call graph for this function:

double ns3::SequentialRandomVariable::GetMax ( void  ) const

Get the limit of the sequence, which is (at least) one more than the last value of the sequence.

Returns
The limit of the sequence.

Definition at line 314 of file random-variable-stream.cc.

References m_max, and NS_LOG_FUNCTION.

double ns3::SequentialRandomVariable::GetMin ( void  ) const

Get the first value of the sequence.

Returns
The first value of the sequence.

Definition at line 307 of file random-variable-stream.cc.

References m_min, and NS_LOG_FUNCTION.

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

Register this type.

Returns
The object TypeId.

Definition at line 270 of file random-variable-stream.cc.

References m_consecutive, m_increment, m_max, m_min, ns3::MakeDoubleAccessor(), ns3::MakeIntegerAccessor(), ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

double ns3::SequentialRandomVariable::GetValue ( void  )
virtual

Member Data Documentation

uint32_t ns3::SequentialRandomVariable::m_consecutive
private

The number of times each distinct value is repeated.

Definition at line 455 of file random-variable-stream.h.

Referenced by GetConsecutive(), GetTypeId(), and GetValue().

double ns3::SequentialRandomVariable::m_current
private

The current sequence value.

Definition at line 458 of file random-variable-stream.h.

Referenced by GetValue().

uint32_t ns3::SequentialRandomVariable::m_currentConsecutive
private

The number of times the current distinct value has been repeated.

Definition at line 461 of file random-variable-stream.h.

Referenced by GetValue().

Ptr<RandomVariableStream> ns3::SequentialRandomVariable::m_increment
private

Increment between distinct values.

Definition at line 452 of file random-variable-stream.h.

Referenced by GetIncrement(), GetTypeId(), and GetValue().

bool ns3::SequentialRandomVariable::m_isCurrentSet
private

Indicates if the current sequence value has been properly initialized.

Definition at line 464 of file random-variable-stream.h.

Referenced by GetValue().

double ns3::SequentialRandomVariable::m_max
private

Strict upper bound on the sequence.

Definition at line 449 of file random-variable-stream.h.

Referenced by GetMax(), GetTypeId(), and GetValue().

double ns3::SequentialRandomVariable::m_min
private

The first value of the sequence.

Definition at line 446 of file random-variable-stream.h.

Referenced by GetMin(), GetTypeId(), and GetValue().


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