Determine which packets are errored corresponding to an underlying distribution, rate, and unit. More...
#include "error-model.h"
Public Types | |
enum | ErrorUnit { ERROR_UNIT_BIT , ERROR_UNIT_BYTE , ERROR_UNIT_PACKET } |
Error unit. More... | |
Public Member Functions | |
RateErrorModel () | |
~RateErrorModel () override | |
int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this model. | |
double | GetRate () const |
RateErrorModel::ErrorUnit | GetUnit () const |
void | SetRandomVariable (Ptr< RandomVariableStream >) |
void | SetRate (double rate) |
void | SetUnit (ErrorUnit error_unit) |
Public Member Functions inherited from ns3::ErrorModel | |
ErrorModel () | |
~ErrorModel () override | |
void | Disable () |
Disable the error model. | |
void | Enable () |
Enable the error model. | |
bool | IsCorrupt (Ptr< Packet > pkt) |
Note: Depending on the error model, this function may or may not alter the contents of the packet upon returning true. | |
bool | IsEnabled () const |
void | Reset () |
Reset any state associated with the error model. | |
Public Member Functions inherited from ns3::Object | |
Object () | |
Constructor. | |
~Object () override | |
Destructor. | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. | |
void | Dispose () |
Dispose of this Object. | |
AggregateIterator | GetAggregateIterator () const |
Get an iterator to the Objects aggregated to this one. | |
TypeId | GetInstanceTypeId () const override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. | |
void | Initialize () |
Invoke DoInitialize on all Objects aggregated to this one. | |
bool | IsInitialized () const |
Check if the object has been initialized. | |
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
SimpleRefCount () | |
Default constructor. | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. | |
uint32_t | GetReferenceCount () const |
Get the reference count of the object. | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. | |
void | Ref () const |
Increment the reference count. | |
void | Unref () const |
Decrement the reference count. | |
Public Member Functions inherited from ns3::ObjectBase | |
virtual | ~ObjectBase () |
Virtual destructor. | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising errors. | |
virtual TypeId | GetInstanceTypeId () const =0 |
Get the most derived TypeId for this Object. | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. | |
Static Public Member Functions | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::ErrorModel | |
static TypeId | GetTypeId () |
Get the type ID. | |
Static Public Member Functions inherited from ns3::Object | |
static TypeId | GetTypeId () |
Register this type. | |
Static Public Member Functions inherited from ns3::ObjectBase | |
static TypeId | GetTypeId () |
Get the type ID. | |
Private Member Functions | |
bool | DoCorrupt (Ptr< Packet > p) override |
Corrupt a packet according to the specified model. | |
virtual bool | DoCorruptBit (Ptr< Packet > p) |
Corrupt a packet (bit unit). | |
virtual bool | DoCorruptByte (Ptr< Packet > p) |
Corrupt a packet (Byte unit). | |
virtual bool | DoCorruptPkt (Ptr< Packet > p) |
Corrupt a packet (packet unit). | |
void | DoReset () override |
Re-initialize any state. | |
Private Attributes | |
Ptr< RandomVariableStream > | m_ranvar |
rng stream | |
double | m_rate |
Error rate. | |
ErrorUnit | m_unit |
Error rate unit. | |
Additional Inherited Members | |
Protected Member Functions inherited from ns3::Object | |
Object (const Object &o) | |
Copy an Object. | |
virtual void | DoDispose () |
Destructor implementation. | |
virtual void | DoInitialize () |
Initialize() implementation. | |
virtual void | NotifyNewAggregate () |
Notify all Objects aggregated to this one of a new Object being aggregated. | |
Protected Member Functions inherited from ns3::ObjectBase | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. | |
virtual void | NotifyConstructionCompleted () |
Notifier called once the ObjectBase is fully constructed. | |
Related Functions inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Determine which packets are errored corresponding to an underlying distribution, rate, and unit.
This object is used to flag packets as being lost/errored or not. The two parameters that govern the behavior are the rate (or equivalently, the mean duration/spacing between errors), and the unit (which may be per-bit, per-byte, and per-packet). Users can optionally provide a RandomVariableStream object; the default is to use a Uniform(0,1) distribution.
Reset() on this model will do nothing
IsCorrupt() will not modify the packet data buffer
ns3::RateErrorModel is accessible through the following paths with Config::Set and Config::Connect:
ERROR_UNIT_BIT|ERROR_UNIT_BYTE|ERROR_UNIT_PACKET
No TraceSources are defined for this type.
Size of this type is 56 bytes (on a 64-bit architecture).
Definition at line 183 of file error-model.h.
Error unit.
The error model can be packet, Byte or bit based.
Enumerator | |
---|---|
ERROR_UNIT_BIT | |
ERROR_UNIT_BYTE | |
ERROR_UNIT_PACKET |
Definition at line 198 of file error-model.h.
ns3::RateErrorModel::RateErrorModel | ( | ) |
Definition at line 183 of file error-model.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 188 of file error-model.cc.
References NS_LOG_FUNCTION.
int64_t ns3::RateErrorModel::AssignStreams | ( | int64_t | stream | ) |
Assign a fixed random variable stream number to the random variables used by this model.
Return the number of streams (possibly zero) that have been assigned.
stream | first stream index to use |
Definition at line 229 of file error-model.cc.
References m_ranvar, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().
Corrupt a packet according to the specified model.
p | the packet to corrupt |
Implements ns3::ErrorModel.
Definition at line 237 of file error-model.cc.
References DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), ERROR_UNIT_BIT, ERROR_UNIT_BYTE, ERROR_UNIT_PACKET, ns3::ErrorModel::IsEnabled(), m_unit, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
Corrupt a packet (bit unit).
p | the packet to corrupt |
Definition at line 276 of file error-model.cc.
References ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION.
Referenced by DoCorrupt().
Corrupt a packet (Byte unit).
p | the packet to corrupt |
Definition at line 267 of file error-model.cc.
References ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION.
Referenced by DoCorrupt().
Corrupt a packet (packet unit).
p | the packet to corrupt |
Definition at line 260 of file error-model.cc.
References ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION.
Referenced by DoCorrupt().
|
overrideprivatevirtual |
Re-initialize any state.
Implements ns3::ErrorModel.
Definition at line 285 of file error-model.cc.
References NS_LOG_FUNCTION.
double ns3::RateErrorModel::GetRate | ( | ) | const |
Definition at line 208 of file error-model.cc.
References m_rate, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 153 of file error-model.cc.
References ERROR_UNIT_BIT, ERROR_UNIT_BYTE, ERROR_UNIT_PACKET, m_ranvar, m_rate, m_unit, ns3::MakeDoubleAccessor(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakePointerAccessor(), and ns3::TypeId::SetParent().
RateErrorModel::ErrorUnit ns3::RateErrorModel::GetUnit | ( | ) | const |
Definition at line 194 of file error-model.cc.
References m_unit, and NS_LOG_FUNCTION.
void ns3::RateErrorModel::SetRandomVariable | ( | Ptr< RandomVariableStream > | ranvar | ) |
ranvar | A random variable distribution to generate random variates |
Definition at line 222 of file error-model.cc.
References m_ranvar, and NS_LOG_FUNCTION.
void ns3::RateErrorModel::SetRate | ( | double | rate | ) |
rate | the error rate to be used by the model |
Definition at line 215 of file error-model.cc.
References m_rate, and NS_LOG_FUNCTION.
Referenced by ThreeGppHttpObjectTestCase::ThreeGppHttpObjectTestCase().
void ns3::RateErrorModel::SetUnit | ( | ErrorUnit | error_unit | ) |
error_unit | the ErrorUnit to be used by the underlying model |
Definition at line 201 of file error-model.cc.
References m_unit, and NS_LOG_FUNCTION.
Referenced by ThreeGppHttpObjectTestCase::ThreeGppHttpObjectTestCase().
|
private |
rng stream
Definition at line 263 of file error-model.h.
Referenced by AssignStreams(), DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), GetTypeId(), and SetRandomVariable().
|
private |
Error rate.
Definition at line 261 of file error-model.h.
Referenced by DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), GetRate(), GetTypeId(), and SetRate().
|
private |
Error rate unit.
Definition at line 260 of file error-model.h.
Referenced by DoCorrupt(), GetTypeId(), GetUnit(), and SetUnit().