Determine which packets are errored corresponding to an underlying distribution, rate, and unit. More...

#include <error-model.h>

Inheritance diagram for ns3::RateErrorModel:

Collaboration diagram for ns3::RateErrorModel:

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)

Public Member Functions inherited from ns3::ErrorModel
	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...

Public Member Functions inherited from ns3::Object
	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...

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	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...

Public Member Functions inherited from ns3::ObjectBase
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 Public Member Functions inherited from ns3::ErrorModel
static TypeId	GetTypeId (void)

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. More...

Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void	Cleanup (void)
	Noop. More...

Static Public Member Functions inherited from ns3::ObjectBase
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
Protected Member Functions inherited from ns3::Object
	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...

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)

virtual void	NotifyConstructionCompleted (void)
	This method is invoked once all member attributes have been initialized. More...

Detailed Description

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

Config Paths

ns3::RateErrorModel is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes

ErrorUnit: The error unit
- Set with class: ns3::EnumValue
- Underlying type: ERROR_UNIT_BIT|ERROR_UNIT_BYTE|ERROR_UNIT_PACKET
- Initial value: ERROR_UNIT_BYTE
- Flags: construct write read
ErrorRate: The error rate.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
RanVar: The decision variable attached to this error model.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::RandomVariableStream >
- Initial value: ns3::UniformRandomVariable[Min=0.0|Max=1.0]
- Flags: construct write read

Attributes defined in parent class ns3::ErrorModel

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