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 } |
Public Member Functions | |
RateErrorModel () | |
virtual | ~RateErrorModel () |
int64_t | AssignStreams (int64_t stream) |
Assign a fixed random variable stream number to the random variables used by this model. More... | |
double | GetRate (void) const |
RateErrorModel::ErrorUnit | GetUnit (void) const |
void | SetRandomVariable (Ptr< RandomVariableStream >) |
void | SetRate (double rate) |
void | SetUnit (enum ErrorUnit error_unit) |
![]() | |
ErrorModel () | |
virtual | ~ErrorModel () |
void | Disable (void) |
Disable the error model. More... | |
void | Enable (void) |
Enable the error model. More... | |
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. More... | |
bool | IsEnabled (void) const |
void | Reset (void) |
Reset any state associated with the error model. 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 Member Functions | |
virtual bool | DoCorrupt (Ptr< Packet > p) |
virtual bool | DoCorruptBit (Ptr< Packet > p) |
virtual bool | DoCorruptByte (Ptr< Packet > p) |
virtual bool | DoCorruptPkt (Ptr< Packet > p) |
virtual void | DoReset (void) |
Private Attributes | |
Ptr< RandomVariableStream > | m_ranvar |
double | m_rate |
enum ErrorUnit | m_unit |
Additional Inherited Members | |
![]() | |
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... | |
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:
No TraceSources are defined for this type.
Definition at line 173 of file error-model.h.
Enumerator | |
---|---|
ERROR_UNIT_BIT | |
ERROR_UNIT_BYTE | |
ERROR_UNIT_PACKET |
Definition at line 181 of file error-model.h.
ns3::RateErrorModel::RateErrorModel | ( | ) |
Definition at line 176 of file error-model.cc.
References NS_LOG_FUNCTION.
|
virtual |
Definition at line 181 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 222 of file error-model.cc.
References m_ranvar, NS_LOG_FUNCTION, and ns3::RandomVariableStream::SetStream().
Implements ns3::ErrorModel.
Definition at line 230 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.
Definition at line 269 of file error-model.cc.
References ns3::Packet::GetSize(), ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION.
Referenced by DoCorrupt().
Definition at line 260 of file error-model.cc.
References ns3::Packet::GetSize(), ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION.
Referenced by DoCorrupt().
Definition at line 253 of file error-model.cc.
References ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION.
Referenced by DoCorrupt().
|
privatevirtual |
Implements ns3::ErrorModel.
Definition at line 278 of file error-model.cc.
References NS_LOG_FUNCTION.
double ns3::RateErrorModel::GetRate | ( | void | ) | const |
Definition at line 201 of file error-model.cc.
References m_rate, and NS_LOG_FUNCTION.
|
static |
Definition at line 152 of file error-model.cc.
References ERROR_UNIT_BIT, ERROR_UNIT_BYTE, ERROR_UNIT_PACKET, m_ranvar, m_rate, m_unit, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), and ns3::TypeId::SetParent().
RateErrorModel::ErrorUnit ns3::RateErrorModel::GetUnit | ( | void | ) | const |
Definition at line 187 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 215 of file error-model.cc.
References m_ranvar, and NS_LOG_FUNCTION.
Referenced by ErrorModelSimple::DoRun(), and main().
void ns3::RateErrorModel::SetRate | ( | double | rate | ) |
rate | the error rate to be used by the model |
Definition at line 208 of file error-model.cc.
References m_rate, and NS_LOG_FUNCTION.
Referenced by main().
void ns3::RateErrorModel::SetUnit | ( | enum ErrorUnit | error_unit | ) |
error_unit | the ErrorUnit to be used by the underlying model |
Definition at line 194 of file error-model.cc.
References m_unit, and NS_LOG_FUNCTION.
Referenced by main().
|
private |
Definition at line 231 of file error-model.h.
Referenced by AssignStreams(), DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), GetTypeId(), and SetRandomVariable().
|
private |
Definition at line 229 of file error-model.h.
Referenced by DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), GetRate(), GetTypeId(), and SetRate().
|
private |
Definition at line 228 of file error-model.h.
Referenced by DoCorrupt(), GetTypeId(), GetUnit(), and SetUnit().