Determine which bursts of packets are errored corresponding to an underlying distribution, burst rate, and burst size. More...
#include "error-model.h"
Public Member Functions | |
BurstErrorModel () | |
~BurstErrorModel () override | |
int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this model. | |
double | GetBurstRate () const |
void | SetBurstRate (double rate) |
void | SetRandomBurstSize (Ptr< RandomVariableStream > burstSz) |
void | SetRandomVariable (Ptr< RandomVariableStream > ranVar) |
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. | |
void | UnidirectionalAggregateObject (Ptr< Object > other) |
Aggregate an Object to another Object. | |
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, bool permissive=false) 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. | |
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. | |
void | DoReset () override |
Re-initialize any state. | |
Private Attributes | |
double | m_burstRate |
the burst error event | |
Ptr< RandomVariableStream > | m_burstSize |
the number of packets being flagged as errored | |
Ptr< RandomVariableStream > | m_burstStart |
the error decision variable | |
uint32_t | m_counter |
keep track of the number of packets being errored until it reaches m_burstSize | |
uint32_t | m_currentBurstSz |
the current burst size | |
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 Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
Determine which bursts of packets are errored corresponding to an underlying distribution, burst rate, and burst size.
This object is used to flag packets as being lost/errored or not. The two parameters that govern the behavior are the burst rate (or equivalently, the mean duration/spacing between between error events), and the burst size (or equivalently, the number of packets being flagged as errored at each error event).
Users can optionally provide RandomVariableStream objects; the default for the decision variable is to use a Uniform(0,1) distribution; the default for the burst size (number of packets) is to use a discrete Uniform[1,4] distribution.
For every packet, the model generates a random number based on the decision variable, and compares it with the burst error rate to determine if a burst error event should occur. If a new error event occurs, the model to will generate a new burst size to determine how many packets should be dropped in this particular burst error event in addition to the current packet.
When a second packet arrives, the model again determines if a new error event should occur based on a newly generated decision variable and the burst error rate. If a new error event is determined to occur, the model will restart with a new burst size. Otherwise, the model will resume the last error event and drop the packet provided that the total number of packets that has been dropped does not exceed the burst size.
IsCorrupt() will not modify the packet data buffer
Definition at line 287 of file error-model.h.
ns3::BurstErrorModel::BurstErrorModel | ( | ) |
Definition at line 312 of file error-model.cc.
|
override |
Definition at line 318 of file error-model.cc.
References NS_LOG_FUNCTION.
int64_t ns3::BurstErrorModel::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 352 of file error-model.cc.
References m_burstSize, m_burstStart, 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 361 of file error-model.cc.
References ns3::RandomVariableStream::GetInteger(), ns3::RandomVariableStream::GetValue(), ns3::ErrorModel::IsEnabled(), m_burstRate, m_burstSize, m_burstStart, m_counter, m_currentBurstSz, NS_LOG_DEBUG, NS_LOG_FUNCTION, and NS_LOG_WARN.
|
overrideprivatevirtual |
Re-initialize any state.
Implements ns3::ErrorModel.
Definition at line 404 of file error-model.cc.
References m_counter, m_currentBurstSz, and NS_LOG_FUNCTION.
double ns3::BurstErrorModel::GetBurstRate | ( | ) | const |
Definition at line 324 of file error-model.cc.
References m_burstRate, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 287 of file error-model.cc.
References m_burstRate, m_burstSize, m_burstStart, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), and ns3::TypeId::SetParent().
void ns3::BurstErrorModel::SetBurstRate | ( | double | rate | ) |
rate | the error rate to be used by the model |
Definition at line 331 of file error-model.cc.
References m_burstRate, and NS_LOG_FUNCTION.
void ns3::BurstErrorModel::SetRandomBurstSize | ( | Ptr< RandomVariableStream > | burstSz | ) |
burstSz | A random variable distribution to generate random burst size |
Definition at line 345 of file error-model.cc.
References m_burstSize, and NS_LOG_FUNCTION.
void ns3::BurstErrorModel::SetRandomVariable | ( | Ptr< RandomVariableStream > | ranVar | ) |
ranVar | A random variable distribution to generate random variates |
Definition at line 338 of file error-model.cc.
References m_burstStart, and NS_LOG_FUNCTION.
|
private |
the burst error event
Definition at line 332 of file error-model.h.
Referenced by DoCorrupt(), GetBurstRate(), GetTypeId(), and SetBurstRate().
|
private |
the number of packets being flagged as errored
Definition at line 334 of file error-model.h.
Referenced by AssignStreams(), DoCorrupt(), GetTypeId(), and SetRandomBurstSize().
|
private |
the error decision variable
Definition at line 333 of file error-model.h.
Referenced by AssignStreams(), DoCorrupt(), GetTypeId(), and SetRandomVariable().
|
private |
keep track of the number of packets being errored until it reaches m_burstSize
Definition at line 340 of file error-model.h.
Referenced by DoCorrupt(), and DoReset().
|
private |
the current burst size
Definition at line 341 of file error-model.h.
Referenced by DoCorrupt(), and DoReset().