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:

Public Member Functions
	ErrorModel ()
virtual	~ErrorModel ()
void	Disable (void)
void	Enable (void)
bool	IsCorrupt (Ptr< Packet > pkt)
bool	IsEnabled (void) const
void	Reset (void)
Public Member Functions inherited from ns3::Object
	Object ()
virtual	~Object ()
void	AggregateObject (Ptr< Object > other)
void	Dispose (void)
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	Start (void)
Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	SimpleRefCount (const SimpleRefCount &o)
uint32_t	GetReferenceCount (void) const
SimpleRefCount &	operator= (const SimpleRefCount &o)
void	Ref (void) const
void	Unref (void) const
Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
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)
	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

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

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> ();
Ptr<UniformRandomVariable> uv = CreateObject<UniformRandomVariable> ();
rem->SetRandomVariable (uv);
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 107 of file error-model.h.

Constructor & Destructor Documentation

ns3::ErrorModel::ErrorModel ( )

Definition at line 86 of file error-model.cc.

References NS_LOG_FUNCTION_NOARGS.

ns3::ErrorModel::~ErrorModel ( )

virtual

Definition at line 92 of file error-model.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

void ns3::ErrorModel::Disable ( void )

Disable the error model

Definition at line 123 of file error-model.cc.

References m_enable, and NS_LOG_FUNCTION_NOARGS.

virtual bool ns3::ErrorModel::DoCorrupt ( Ptr< Packet > )

privatepure virtual

Referenced by IsCorrupt().

Here is the caller graph for this function:

virtual void ns3::ErrorModel::DoReset ( void )

privatepure virtual

Referenced by Reset().

Here is the caller graph for this function:

void ns3::ErrorModel::Enable ( void )

Enable the error model

Definition at line 116 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:

/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, ns3::RateErrorModel, and ns3::BinaryErrorModel.

Definition at line 74 of file error-model.cc.

References m_enable, and ns3::TypeId::SetParent().

Here is the call graph for this function: