A Discrete-Event Network Simulator
API
ns3::ReceiveListErrorModel Class Reference

Provide a list of Packets to corrupt. More...

#include "error-model.h"

+ Inheritance diagram for ns3::ReceiveListErrorModel:
+ Collaboration diagram for ns3::ReceiveListErrorModel:

Public Member Functions

 ReceiveListErrorModel ()
 
virtual ~ReceiveListErrorModel ()
 
std::list< uint32_t > GetList (void) const
 
void SetList (const std::list< uint32_t > &packetlist)
 
- 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<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject () const
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 
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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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 Types

typedef std::list< uint32_t > PacketList
 Typedef: packet sequence number list. More...
 
typedef std::list< uint32_t >::const_iterator PacketListCI
 Typedef: packet sequence number list const iterator. 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

PacketList m_packetList
 container of sequence number of packets to corrupt More...
 
uint32_t m_timesInvoked
 number of times the error model has been invoked 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...
 

Detailed Description

Provide a list of Packets to corrupt.


This model also processes a user-generated list of packets to corrupt, except that the list corresponds to the sequence of received packets as observed by this error model, and not the Packet UID.

Reset() on this model will clear the list

IsCorrupt() will not modify the packet data buffer

Config Paths

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

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

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 56 bytes (on a 64-bit architecture).

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

Member Typedef Documentation

◆ PacketList

Typedef: packet sequence number list.

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

◆ PacketListCI

typedef std::list<uint32_t>::const_iterator ns3::ReceiveListErrorModel::PacketListCI
private

Typedef: packet sequence number list const iterator.

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

Constructor & Destructor Documentation

◆ ReceiveListErrorModel()

ns3::ReceiveListErrorModel::ReceiveListErrorModel ( )

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

References NS_LOG_FUNCTION.

◆ ~ReceiveListErrorModel()

ns3::ReceiveListErrorModel::~ReceiveListErrorModel ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

◆ DoCorrupt()

bool ns3::ReceiveListErrorModel::DoCorrupt ( Ptr< Packet p)
privatevirtual

Corrupt a packet according to the specified model.

Parameters
pthe packet to corrupt
Returns
true if the packet is corrupted

Implements ns3::ErrorModel.

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

References ns3::ErrorModel::IsEnabled(), m_packetList, m_timesInvoked, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoReset()

void ns3::ReceiveListErrorModel::DoReset ( void  )
privatevirtual

Re-initialize any state.

Implements ns3::ErrorModel.

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

References m_packetList, and NS_LOG_FUNCTION.

◆ GetList()

std::list< uint32_t > ns3::ReceiveListErrorModel::GetList ( void  ) const
Returns
a copy of the underlying list

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

References m_packetList, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::ReceiveListErrorModel::GetTypeId ( void  )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ SetList()

void ns3::ReceiveListErrorModel::SetList ( const std::list< uint32_t > &  packetlist)
Parameters
packetlistThe list of packets to error.

This method overwrites any previously provided list.

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

References m_packetList, and NS_LOG_FUNCTION.

Referenced by TcpLargeTransferLossTest::CreateReceiverErrorModel(), NscTcpLossTestCase1::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), WifiTxopTest::DoRun(), NscTcpLossTestCase2::DoRun(), and Bug2470TestCase::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_packetList

PacketList ns3::ReceiveListErrorModel::m_packetList
private

container of sequence number of packets to corrupt

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

Referenced by DoCorrupt(), DoReset(), GetList(), and SetList().

◆ m_timesInvoked

uint32_t ns3::ReceiveListErrorModel::m_timesInvoked
private

number of times the error model has been invoked

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

Referenced by DoCorrupt().


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