General error model that can be used to corrupt packets. More...
#include <error-model.h>
Public Member Functions | |
ErrorModel () | |
virtual | ~ErrorModel () |
bool | IsCorrupt (Ptr< Packet > pkt) |
void | Reset (void) |
void | Enable (void) |
void | Disable (void) |
bool | IsEnabled (void) const |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
This method returns the TypeId associated to ns3::ErrorModel. | |
Private Member Functions | |
virtual bool | DoCorrupt (Ptr< Packet >)=0 |
virtual void | DoReset (void)=0 |
Private Attributes | |
bool | m_enable |
General error model that can be used to corrupt packets.
This object is used to flag packets as being lost/errored or not. It is part of the Object framework and can be aggregated to other ns3 objects and handled by the Ptr class.
The main method is IsCorrupt(Ptr<Packet> p) which returns true if the packet is to be corrupted according to the underlying model. Depending on the error model, the packet itself may have its packet data buffer errored or not, or side information may be returned to the client in the form of a packet tag. The object can have state (resettable by Reset()). The object can also be enabled and disabled via two public member functions.
Typical code (simplified) to use an ErrorModel may look something like this:
Ptr<ErrorModel> rem = CreateObject<RateErrorModel> (); rem->SetRandomVariable (UniformVariable ()); rem->SetRate (0.001); ... Ptr<Packet> p; if (rem->IsCorrupt (p)) { dropTrace(p); } else { Forward (p); }
Two practical error models, a ListErrorModel and a RateErrorModel, are currently implemented.
Definition at line 71 of file error-model.h.
ns3::ErrorModel::ErrorModel | ( | ) |
Definition at line 52 of file error-model.cc.
References NS_LOG_FUNCTION_NOARGS.
ns3::ErrorModel::~ErrorModel | ( | ) | [virtual] |
Definition at line 58 of file error-model.cc.
References NS_LOG_FUNCTION_NOARGS.
void ns3::ErrorModel::Disable | ( | void | ) |
Disable the error model
Definition at line 89 of file error-model.cc.
References m_enable, and NS_LOG_FUNCTION_NOARGS.
Implemented in ns3::RateErrorModel, and ns3::ListErrorModel.
Referenced by IsCorrupt().
virtual void ns3::ErrorModel::DoReset | ( | void | ) | [private, pure virtual] |
Implemented in ns3::RateErrorModel, and ns3::ListErrorModel.
Referenced by Reset().
void ns3::ErrorModel::Enable | ( | void | ) |
Enable the error model
Definition at line 82 of file error-model.cc.
References m_enable, and NS_LOG_FUNCTION_NOARGS.
TypeId ns3::ErrorModel::GetTypeId | ( | void | ) | [static] |
This method returns the TypeId associated to ns3::ErrorModel.
This object is accessible through the following paths with Config::Set and Config::Connect:
Attributes defined for this type:
No TraceSources defined for this type.
Reimplemented from ns3::Object.
Reimplemented in ns3::RateErrorModel, and ns3::ListErrorModel.
Definition at line 40 of file error-model.cc.
References m_enable, and ns3::TypeId::SetParent().
pkt | Packet to apply error model to |
Definition at line 64 of file error-model.cc.
References DoCorrupt(), and NS_LOG_FUNCTION_NOARGS.
bool ns3::ErrorModel::IsEnabled | ( | void | ) | const |
Definition at line 96 of file error-model.cc.
References m_enable, and NS_LOG_FUNCTION_NOARGS.
Referenced by ns3::ListErrorModel::DoCorrupt(), and ns3::RateErrorModel::DoCorrupt().
void ns3::ErrorModel::Reset | ( | void | ) |
Reset any state associated with the error model
Definition at line 75 of file error-model.cc.
References DoReset(), and NS_LOG_FUNCTION_NOARGS.
bool ns3::ErrorModel::m_enable [private] |
Definition at line 108 of file error-model.h.
Referenced by Disable(), Enable(), GetTypeId(), and IsEnabled().