The Random Number Generator (RNG) that returns a constant. More...
#include <random-variable-stream.h>
Inheritance diagram for ns3::ConstantRandomVariable:
Collaboration diagram for ns3::ConstantRandomVariable: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... | |
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 | |
| double | m_constant |
| The constant value returned by this RNG stream. 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... | |
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.
Size of this type is 64 bytes (on a 64-bit architecture).
Definition at line 307 of file random-variable-stream.h.
| ns3::ConstantRandomVariable::ConstantRandomVariable | ( | ) |
Creates a constant RNG with the default constant value.
Definition at line 227 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 234 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 247 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 260 of file random-variable-stream.cc.
References GetValue(), m_constant, and NS_LOG_FUNCTION.
Here is the call graph for this function:
|
static |
Definition at line 214 of file random-variable-stream.cc.
References m_constant, ns3::MakeDoubleAccessor(), and ns3::TypeId::SetParent().
Here is the call graph for this function:| double ns3::ConstantRandomVariable::GetValue | ( | double | constant | ) |
Returns the value passed in.
Definition at line 241 of file random-variable-stream.cc.
References NS_LOG_FUNCTION.
Referenced by RandomVariableStreamConstantTestCase::DoRun().
Here is the caller graph for this function:
|
virtual |
Returns the constant value returned by this RNG stream.
Implements ns3::RandomVariableStream.
Definition at line 254 of file random-variable-stream.cc.
References m_constant, and NS_LOG_FUNCTION.
Referenced by GetInteger().
Here is the caller graph for this function:
|
private |
The constant value returned by this RNG stream.
Definition at line 348 of file random-variable-stream.h.
Referenced by GetConstant(), GetInteger(), GetTypeId(), and GetValue().