The simplest error model, corrupts even packets and does not corrupt odd ones. More...

#include "error-model.h"

Inheritance diagram for ns3::BinaryErrorModel:

Collaboration diagram for ns3::BinaryErrorModel:

Public Member Functions
	BinaryErrorModel ()

virtual	~BinaryErrorModel ()

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 ()
	Constructor. More...

virtual	~Object ()
	Destructor. More...

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

void	Dispose (void)
	Dispose of this Object. More...

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

virtual TypeId	GetInstanceTypeId (void) const
	Get the most derived TypeId for this Object. More...

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

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

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

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

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

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

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

	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...

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

SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. 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
	Get the value of an attribute, raising fatal errors if unsuccessful. More...

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

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

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

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

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

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

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

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

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

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId (void)
	Register this type. 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)
	Corrupt a packet according to the specified model. More...

virtual void	DoReset (void)
	Re-initialize any state. More...

Private Attributes
uint8_t	m_counter
	internal state counter. More...

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

virtual void	DoDispose (void)
	Destructor implementation. More...

virtual void	DoInitialize (void)
	Initialize() implementation. More...

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

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

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

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

Detailed Description

The simplest error model, corrupts even packets and does not corrupt odd ones.

Config Paths

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

"/NodeList/[i]/DeviceList/[i]/$ns3::SimpleNetDevice/ReceiveErrorModel/$ns3::BinaryErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::PointToPointNetDevice/ReceiveErrorModel/$ns3::BinaryErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/PostReceptionErrorModel/$ns3::BinaryErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/PostReceptionErrorModel/$ns3::BinaryErrorModel"
"/NodeList/[i]/DeviceList/[i]/$ns3::CsmaNetDevice/ReceiveErrorModel/$ns3::BinaryErrorModel"

No Attributes are defined for this type.

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

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

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

Constructor & Destructor Documentation

◆ BinaryErrorModel()

ns3::BinaryErrorModel::BinaryErrorModel ( )

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

References m_counter, and NS_LOG_FUNCTION.

◆ ~BinaryErrorModel()

ns3::BinaryErrorModel::~BinaryErrorModel ( )

virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoCorrupt()

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

privatevirtual

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 577 of file error-model.cc.

References ns3::ErrorModel::IsEnabled(), m_counter, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoReset()

void ns3::BinaryErrorModel::DoReset ( void )

privatevirtual

Re-initialize any state.

Implements ns3::ErrorModel.

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

References m_counter, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::BinaryErrorModel::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::TypeId::SetParent().

Here is the call graph for this function:

Member Data Documentation

◆ m_counter

uint8_t ns3::BinaryErrorModel::m_counter

private

internal state counter.

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

Referenced by BinaryErrorModel(), DoCorrupt(), and DoReset().

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

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

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members