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)
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)
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::RateErrorModel.

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)
virtual void	DoStart (void)
virtual void	NotifyNewAggregate (void)

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

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

Member Enumeration Documentation

enum ns3::RateErrorModel::ErrorUnit

Enumerator:

ERROR_UNIT_BIT
ERROR_UNIT_BYTE
ERROR_UNIT_PACKET

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

Constructor & Destructor Documentation

ns3::RateErrorModel::RateErrorModel ( )

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

References NS_LOG_FUNCTION_NOARGS.

ns3::RateErrorModel::~RateErrorModel ( )

virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

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

References m_ranvar, and ns3::RandomVariableStream::SetStream().

Here is the call graph for this function:

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

privatevirtual

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

Here is the call graph for this function:

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

privatevirtual

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

References ns3::Packet::GetSize(), ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION_NOARGS.

Referenced by DoCorrupt().

Here is the call graph for this function:

Here is the caller graph for this function:

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

privatevirtual

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

References ns3::Packet::GetSize(), ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION_NOARGS.

Referenced by DoCorrupt().

Here is the call graph for this function:

Here is the caller graph for this function:

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

privatevirtual

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

References ns3::RandomVariableStream::GetValue(), m_ranvar, m_rate, and NS_LOG_FUNCTION_NOARGS.

Referenced by DoCorrupt().

Here is the call graph for this function:

Here is the caller graph for this function:

void ns3::RateErrorModel::DoReset ( void )

privatevirtual

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

References NS_LOG_FUNCTION_NOARGS.

double ns3::RateErrorModel::GetRate ( void ) const

Returns: the error rate being applied by the model

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

References m_rate, and NS_LOG_FUNCTION_NOARGS.

TypeId ns3::RateErrorModel::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::RateErrorModel.

This object 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 defined for this type:

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

No TraceSources defined for this type.

Reimplemented from ns3::ErrorModel.

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

References ERROR_UNIT_BIT, ERROR_UNIT_BYTE, ERROR_UNIT_PACKET, m_ranvar, m_rate, m_unit, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function: