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 }
	Error unit. More...

Public Member Functions
	RateErrorModel ()

	~RateErrorModel () override

int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model.

double	GetRate () const

RateErrorModel::ErrorUnit	GetUnit () const

void	SetRandomVariable (Ptr< RandomVariableStream >)

void	SetRate (double rate)

void	SetUnit (ErrorUnit error_unit)

Public Member Functions inherited from ns3::ErrorModel
	ErrorModel ()

	~ErrorModel () override

void	Disable ()
	Disable the error model.

void	Enable ()
	Enable the error model.

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.

bool	IsEnabled () const

void	Reset ()
	Reset any state associated with the error model.

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const final
	Get the most derived TypeId for this Object.

template<typename T>
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T>
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ErrorModel
static TypeId	GetTypeId ()
	Get the type ID.

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

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Member Functions
bool	DoCorrupt (Ptr< Packet > p) override
	Corrupt a packet according to the specified model.

virtual bool	DoCorruptBit (Ptr< Packet > p)
	Corrupt a packet (bit unit).

virtual bool	DoCorruptByte (Ptr< Packet > p)
	Corrupt a packet (Byte unit).

virtual bool	DoCorruptPkt (Ptr< Packet > p)
	Corrupt a packet (packet unit).

void	DoReset () override
	Re-initialize any state.

Private Attributes
Ptr< RandomVariableStream >	m_ranvar
	rng stream

double	m_rate
	Error rate.

ErrorUnit	m_unit
	Error rate unit.

Additional Inherited Members
Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

virtual void	DoInitialize ()
	Initialize() implementation.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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::SimpleNetDevice/ReceiveErrorModel/$ns3::RateErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/PostReceptionErrorModel/$ns3::RateErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phys/[i]/PostReceptionErrorModel/$ns3::RateErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::RateErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::RateErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::lrwpan::LrWpanNetDevice/Phy/PostReceptionErrorModel/$ns3::RateErrorModel"

Attributes

ErrorRate: The error rate.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: constructwriteread
- Support level: SUPPORTED
ErrorUnit: The error unit
- Set with class: ns3::EnumValue<ns3::RateErrorModel::ErrorUnit>
- Underlying type: ERROR_UNIT_BIT|ERROR_UNIT_BYTE|ERROR_UNIT_PACKET
- Initial value: ERROR_UNIT_BYTE
- Flags: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED

Attributes defined in parent class ns3::ErrorModel

IsEnabled: Whether this ErrorModel is enabled or not.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type
Group: Network
Size of this type is 80 bytes (on a 64-bit architecture).

Definition at line 172 of file error-model.h.

Member Enumeration Documentation

◆ ErrorUnit

enum ns3::RateErrorModel::ErrorUnit

Error unit.

The error model can be packet, Byte or bit based.

Enumerator
ERROR_UNIT_BIT
ERROR_UNIT_BYTE
ERROR_UNIT_PACKET

Definition at line 187 of file error-model.h.

Constructor & Destructor Documentation

◆ RateErrorModel()

ns3::RateErrorModel::RateErrorModel ( )

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

References NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ ~RateErrorModel()

ns3::RateErrorModel::~RateErrorModel ( )

override

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

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.

Parameters

stream first stream index to use

Returns: the number of stream indices assigned by this model

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

References m_ranvar, and NS_LOG_FUNCTION.

◆ DoCorrupt()

bool ns3::RateErrorModel::DoCorrupt ( Ptr< Packet > p )

overrideprivatevirtual

Corrupt a packet according to the specified model.

Parameters

p	the packet to corrupt

Returns: true if the packet is corrupted

Implements ns3::ErrorModel.

Definition at line 226 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.

Here is the call graph for this function:

◆ DoCorruptBit()

bool ns3::RateErrorModel::DoCorruptBit ( Ptr< Packet > p )

privatevirtual

Corrupt a packet (bit unit).

Parameters

p	the packet to corrupt

Returns: true if the packet is corrupted

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

References m_ranvar, m_rate, and NS_LOG_FUNCTION.

Referenced by DoCorrupt().

Here is the caller graph for this function:

◆ DoCorruptByte()

bool ns3::RateErrorModel::DoCorruptByte ( Ptr< Packet > p )

privatevirtual

Corrupt a packet (Byte unit).

Parameters

p	the packet to corrupt

Returns: true if the packet is corrupted

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

References m_ranvar, m_rate, and NS_LOG_FUNCTION.

Referenced by DoCorrupt().

Here is the caller graph for this function:

◆ DoCorruptPkt()

bool ns3::RateErrorModel::DoCorruptPkt ( Ptr< Packet > p )

privatevirtual

Corrupt a packet (packet unit).

Parameters

p	the packet to corrupt

Returns: true if the packet is corrupted

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

References m_ranvar, m_rate, and NS_LOG_FUNCTION.

Referenced by DoCorrupt().

Here is the caller graph for this function:

◆ DoReset()

void ns3::RateErrorModel::DoReset ( )

overrideprivatevirtual

Re-initialize any state.

Implements ns3::ErrorModel.

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

References NS_LOG_FUNCTION.

◆ GetRate()

double ns3::RateErrorModel::GetRate ( ) const

Returns: the error rate being applied by the model

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

References m_rate, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::RateErrorModel::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::ErrorModel::ErrorModel(), RateErrorModel(), ERROR_UNIT_BIT, ERROR_UNIT_BYTE, ERROR_UNIT_PACKET, m_ranvar, m_rate, m_unit, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakePointerAccessor(), ns3::MakePointerChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetUnit()

RateErrorModel::ErrorUnit ns3::RateErrorModel::GetUnit ( ) const

Returns: the ErrorUnit being used by the underlying model

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

References m_unit, and NS_LOG_FUNCTION.

◆ SetRandomVariable()

void ns3::RateErrorModel::SetRandomVariable ( Ptr< RandomVariableStream > ranvar )

Parameters

ranvar A random variable distribution to generate random variates

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

References m_ranvar, and NS_LOG_FUNCTION.

◆ SetRate()

void ns3::RateErrorModel::SetRate ( double rate )

Parameters

rate	the error rate to be used by the model

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

References m_rate, and NS_LOG_FUNCTION.

◆ SetUnit()

void ns3::RateErrorModel::SetUnit ( ErrorUnit error_unit )

Parameters

error_unit the ErrorUnit to be used by the underlying model

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

References m_unit, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_ranvar

Ptr<RandomVariableStream> ns3::RateErrorModel::m_ranvar

private

rng stream

Definition at line 252 of file error-model.h.

Referenced by AssignStreams(), DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), GetTypeId(), and SetRandomVariable().

◆ m_rate

double ns3::RateErrorModel::m_rate

private

Error rate.

Definition at line 250 of file error-model.h.

Referenced by DoCorruptBit(), DoCorruptByte(), DoCorruptPkt(), GetRate(), GetTypeId(), and SetRate().

◆ m_unit

ErrorUnit ns3::RateErrorModel::m_unit

private

Error rate unit.

Definition at line 249 of file error-model.h.

Referenced by DoCorrupt(), GetTypeId(), GetUnit(), and SetUnit().

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

src/network/utils/error-model.h
src/network/utils/error-model.cc

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Config Paths

Attributes

Attributes defined in parent class ns3::ErrorModel

Member Enumeration Documentation

◆ ErrorUnit

Constructor & Destructor Documentation

◆ RateErrorModel()

◆ ~RateErrorModel()

Member Function Documentation

◆ AssignStreams()

◆ DoCorrupt()

◆ DoCorruptBit()

◆ DoCorruptByte()

◆ DoCorruptPkt()

◆ DoReset()

◆ GetRate()

◆ GetTypeId()

◆ GetUnit()

◆ SetRandomVariable()

◆ SetRate()

◆ SetUnit()

Member Data Documentation

◆ m_ranvar

◆ m_rate

◆ m_unit