ns-3
ns3::ErrorModel Class Reference

General error model that can be used to corrupt packets. More...

#include <error-model.h>

Inheritance diagram for ns3::ErrorModel:
Collaboration diagram for ns3::ErrorModel:

List of all members.

Public Member Functions

bool IsCorrupt (Ptr< Packet > pkt)
void Reset (void)
void Enable (void)
void Disable (void)
bool IsEnabled (void) const
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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)
 This method returns the TypeId associated to ns3::ErrorModel.

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
virtual void NotifyNewAggregate (void)
virtual void DoStart (void)
virtual void DoDispose (void)
 Object (const Object &o)

Detailed Description

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. (Note: No such error models that actually error the bits in a packet presently exist). 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.


Member Function Documentation

void ns3::ErrorModel::Disable ( void  )

Disable the error model

References NS_LOG_FUNCTION_NOARGS.

void ns3::ErrorModel::Enable ( void  )

Enable the error model

References 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:

  • /NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel
  • /NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel

Attributes defined for this type:

  • IsEnabled: Whether this ErrorModel is enabled or not.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

No TraceSources defined for this type.

Reimplemented from ns3::Object.

Reimplemented in ns3::ReceiveListErrorModel, ns3::ListErrorModel, and ns3::RateErrorModel.

References ns3::TypeId::SetParent().

bool ns3::ErrorModel::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.

Returns:
true if the Packet is to be considered as errored/corrupted
Parameters:
pktPacket to apply error model to

References NS_LOG_FUNCTION_NOARGS.

Referenced by ns3::PointToPointNetDevice::Receive(), and ns3::CsmaNetDevice::Receive().

bool ns3::ErrorModel::IsEnabled ( void  ) const
Returns:
true if error model is enabled; false otherwise

References NS_LOG_FUNCTION_NOARGS.

void ns3::ErrorModel::Reset ( void  )

Reset any state associated with the error model

References NS_LOG_FUNCTION_NOARGS.


The documentation for this class was generated from the following files: