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.
uint32_t	GetConsecutive (void) const
	Returns the number of times each member of the sequence is repeated.
Ptr< RandomVariableStream >	GetIncrement (void) const
	Returns the random variable increment for the sequence.
virtual uint32_t	GetInteger (void)
	Returns an integer cast of the next value in the sequence returned by this RNG stream.
double	GetMax (void) const
	Returns one more than the last value of the sequence.
double	GetMin (void) const
	Returns the first value of the sequence.
virtual double	GetValue (void)
	Returns the next value in the sequence returned by this RNG stream.
Public Member Functions inherited from ns3::RandomVariableStream
	RandomVariableStream ()
virtual	~RandomVariableStream ()
int64_t	GetStream (void) const
	Returns the stream number for this RNG stream.
bool	IsAntithetic (void) const
	Returns true if antithetic values should be generated.
void	SetAntithetic (bool isAntithetic)
	Specifies whether antithetic values should be generated.
void	SetStream (int64_t stream)
	Specifies the stream number for this RNG stream.
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
SimpleRefCount &	operator= (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::SequentialRandomVariable.

Private Attributes
uint32_t	m_consecutive
	The number of times each member of the sequence is repeated.
double	m_current
	The current sequence value.
uint32_t	m_currentConsecutive
	The number of times the sequence has been repeated.
Ptr< RandomVariableStream >	m_increment
	The sequence random variable increment.
bool	m_isCurrentSet
	Indicates if the current sequence value has been set.
double	m_max
	One more than the last value of the sequence.
double	m_min
	The first value of the sequence.

Additional Inherited Members
Protected Member Functions inherited from ns3::RandomVariableStream
RngStream *	Peek (void) const
	Returns a pointer to the underlying RNG stream.

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.

Definition at line 327 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 264 of file random-variable-stream.cc.

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 293 of file random-variable-stream.cc.

References m_consecutive.

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 287 of file random-variable-stream.cc.

References m_increment.

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 324 of file random-variable-stream.cc.

References GetValue().

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 281 of file random-variable-stream.cc.

References m_max.

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

Returns the first value of the sequence.

Returns: The first value of the sequence.

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

References m_min.

TypeId ns3::SequentialRandomVariable::GetTypeId ( void )

static

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

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

/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanDirection/$ns3::SequentialRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanPitch/$ns3::SequentialRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::GaussMarkovMobilityModel/MeanVelocity/$ns3::SequentialRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Pause/$ns3::SequentialRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomDirection2dMobilityModel/Speed/$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/Pause/$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/Rho/$ns3::SequentialRandomVariable
/NodeList/[i]/$ns3::MobilityModel/$ns3::RandomWaypointMobilityModel/PositionAllocator/$ns3::RandomDiscPositionAllocator/Theta/$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/Speed/$ns3::SequentialRandomVariable
/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OffTime/$ns3::SequentialRandomVariable
/NodeList/[i]/ApplicationList/[i]/$ns3::OnOffApplication/OnTime/$ns3::SequentialRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::SequentialRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::SequentialRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::RateErrorModel/RanVar/$ns3::SequentialRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationDelayModel/$ns3::RandomPropagationDelayModel/Variable/$ns3::SequentialRandomVariable
/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Channel/$ns3::YansWifiChannel/PropagationLossModel/$ns3::RandomPropagationLossModel/Variable/$ns3::SequentialRandomVariable

Attributes defined for this type:

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