The Random Number Generator (RNG) that returns a constant. More...
#include <random-variable-stream.h>
Public Member Functions | |
ConstantRandomVariable () | |
Creates a constant RNG with the default constant value. More... | |
double | GetConstant (void) const |
Returns the constant value returned by this RNG stream. More... | |
uint32_t | GetInteger (uint32_t constant) |
Returns the value passed in. More... | |
virtual uint32_t | GetInteger (void) |
Returns an integer cast of the constant value returned by this RNG stream. More... | |
double | GetValue (double constant) |
Returns the value passed in. More... | |
virtual double | GetValue (void) |
Returns the constant value returned by this RNG stream. More... | |
![]() | |
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... | |
![]() | |
Object () | |
virtual | ~Object () |
void | AggregateObject (Ptr< Object > other) |
void | Dispose (void) |
Run the DoDispose methods of this object and all the objects aggregated to it. More... | |
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 | Initialize (void) |
This method calls the virtual DoInitialize method on all the objects aggregated to this object. More... | |
![]() | |
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... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
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) |
![]() | |
static TypeId | GetTypeId (void) |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static void | Cleanup (void) |
Noop. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Attributes | |
double | m_constant |
The constant value returned by this RNG stream. More... | |
Additional Inherited Members | |
![]() | |
RngStream * | Peek (void) const |
Returns a pointer to the underlying RNG stream. More... | |
![]() | |
Object (const Object &o) | |
virtual void | DoDispose (void) |
This method is called by Object::Dispose or by the object's destructor, whichever comes first. More... | |
virtual void | DoInitialize (void) |
This method is called only once by Object::Initialize. More... | |
virtual void | NotifyNewAggregate (void) |
This method is invoked whenever two sets of objects are aggregated together. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
virtual void | NotifyConstructionCompleted (void) |
This method is invoked once all member attributes have been initialized. More... | |
The Random Number Generator (RNG) that returns a constant.
Class ConstantRandomVariable returns the same value for every sample.
ns3::ConstantRandomVariable is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Definition at line 303 of file random-variable-stream.h.
ns3::ConstantRandomVariable::ConstantRandomVariable | ( | ) |
Creates a constant RNG with the default constant value.
Definition at line 221 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
double ns3::ConstantRandomVariable::GetConstant | ( | void | ) | const |
Returns the constant value returned by this RNG stream.
Definition at line 228 of file random-variable-stream.cc.
References m_constant, and NS_LOG_FUNCTION.
uint32_t ns3::ConstantRandomVariable::GetInteger | ( | uint32_t | constant | ) |
Returns the value passed in.
Definition at line 241 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
|
virtual |
Returns an integer cast of the constant value returned by this RNG stream.
Implements ns3::RandomVariableStream.
Definition at line 254 of file random-variable-stream.cc.
References GetValue(), m_constant, and NS_LOG_FUNCTION.
|
static |
Definition at line 209 of file random-variable-stream.cc.
References m_constant, and ns3::TypeId::SetParent().
double ns3::ConstantRandomVariable::GetValue | ( | double | constant | ) |
Returns the value passed in.
Definition at line 235 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
Referenced by RandomVariableStreamConstantTestCase::DoRun().
|
virtual |
Returns the constant value returned by this RNG stream.
Implements ns3::RandomVariableStream.
Definition at line 248 of file random-variable-stream.cc.
References m_constant, and NS_LOG_FUNCTION.
Referenced by GetInteger().
|
private |
The constant value returned by this RNG stream.
Definition at line 344 of file random-variable-stream.h.
Referenced by GetConstant(), GetInteger(), GetTypeId(), and GetValue().