The Random Number Generator (RNG) that returns a sequential list of 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
	Returns the number of times each member of the sequence is repeated. More...

Ptr< RandomVariableStream >	GetIncrement (void) const
	Returns the random variable increment for the sequence. More...

virtual uint32_t	GetInteger (void)
	Returns an integer cast of the next value in the sequence returned by this RNG stream. More...

double	GetMax (void) const
	Returns one more than the last value of the sequence. More...

double	GetMin (void) const
	Returns the first value of the sequence. More...

virtual double	GetValue (void)
	Returns the next value in the sequence returned by this RNG stream. More...

Public Member Functions inherited from ns3::RandomVariableStream
	RandomVariableStream ()

virtual	~RandomVariableStream ()

int64_t	GetStream (void) const
	Returns the stream number for this RNG stream. More...

bool	IsAntithetic (void) const
	Returns true if antithetic values should be generated. More...

void	SetAntithetic (bool isAntithetic)
	Specifies whether antithetic values should be generated. More...

void	SetStream (int64_t stream)
	Specifies the stream number for this RNG stream. 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
	Implement the GetInstanceTypeId method defined in ObjectBase. 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. More...

void	Initialize (void)
	Invoke DoInitialize on all Objects aggregated to this one. More...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment. 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)

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::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. 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 member of the sequence is repeated. More...

double	m_current
	The current sequence value. More...

uint32_t	m_currentConsecutive
	The number of times the sequence has been repeated. More...

Ptr< RandomVariableStream >	m_increment
	The sequence random variable increment. More...

bool	m_isCurrentSet
	Indicates if the current sequence value has been set. More...

double	m_max
	One more than the last value of the sequence. More...

double	m_min
	The first value of the sequence. More...

Additional Inherited Members
Protected Member Functions inherited from ns3::RandomVariableStream
RngStream *	Peek (void) const
	Returns a pointer to the underlying RNG stream. 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...

Related Functions inherited from ns3::ObjectBase
static TypeId	GetObjectIid (void)
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More...

Detailed Description

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

Class SequentialRandomVariable defines a random number generator that returns a sequence of values. The sequence monotonically increases for a period, then wraps around to the low value and begins monotonically increasing again.

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::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::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::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::OnOffApplication/OnTime/$ns3::SequentialRandomVariable"
"/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OffTime/$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::RandomWalk2dMobilityModel/Direction/$ns3::SequentialRandomVariable"
"/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWalk2dMobilityModel/Speed/$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::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::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"
"/ChannelList/[i]/$ns3::WifiChannel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::SequentialRandomVariable"
"/ChannelList/[i]/$ns3::WifiChannel/$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.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream>
- Initial value: ns3::ConstantRandomVariable[Constant=1]
- Flags: construct write read
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 361 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 284 of file random-variable-stream.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

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

Returns the number of times each member of the sequence is repeated.

Returns: The number of times each member of the sequence is repeated.

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

References m_consecutive, and NS_LOG_FUNCTION.

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

Returns the random variable increment for the sequence.

Returns: The random variable increment for the sequence.

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

References m_increment, and NS_LOG_FUNCTION.

uint32_t ns3::SequentialRandomVariable::GetInteger ( void )

virtual

Returns an integer cast of the next value in the sequence returned by this RNG stream.

Returns: Integer cast of the next value in the sequence returned by this RNG stream.

Implements ns3::RandomVariableStream.

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

References GetValue(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

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

Returns one more than the last value of the sequence.

Returns: One more than the last value of the sequence.

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

References m_max, and NS_LOG_FUNCTION.

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

Returns the first value of the sequence.

Returns: The first value of the sequence.

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

References m_min, and NS_LOG_FUNCTION.

TypeId ns3::SequentialRandomVariable::GetTypeId ( void )

static

Definition at line 260 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

Returns the next value in the sequence returned by this RNG stream.

Returns: The next value in the sequence returned by this RNG stream.

The following four parameters define the sequence. For example,

m_min = 0 (First value of the sequence)
m_max = 5 (One more than the last value of the sequence)
m_increment = 1 (Random variable increment between sequence values)
m_consecutive = 2 (Number of times each member of the sequence is repeated)

creates a RNG that has the sequence 0, 0, 1, 1, 2, 2, 3, 3, 4, 4, 0, 0 ...

Implements ns3::RandomVariableStream.

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

References ns3::RandomVariableStream::GetValue(), m_consecutive, m_current, m_currentConsecutive, m_increment, m_isCurrentSet, m_max, m_min, and NS_LOG_FUNCTION.

Referenced by RandomVariableStreamSequentialTestCase::DoRun(), and GetInteger().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

uint32_t ns3::SequentialRandomVariable::m_consecutive

private

The number of times each member of the sequence is repeated.

Definition at line 427 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 430 of file random-variable-stream.h.

Referenced by GetValue().

uint32_t ns3::SequentialRandomVariable::m_currentConsecutive

private

The number of times the sequence has been repeated.

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

Referenced by GetValue().

Ptr<RandomVariableStream> ns3::SequentialRandomVariable::m_increment

private

The sequence random variable increment.

Definition at line 424 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 set.

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

Referenced by GetValue().

double ns3::SequentialRandomVariable::m_max

private

One more than the last value of the sequence.

Definition at line 421 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 418 of file random-variable-stream.h.

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

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

src/core/model/random-variable-stream.h
src/core/model/random-variable-stream.cc

Public Member Functions

Static Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::RandomVariableStream

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation