A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Static Public Member Functions | Private Types | Private Member Functions | Private Attributes | List of all members
ns3::ListErrorModel Class Reference

Provide a list of Packet uids to corrupt. More...

#include <error-model.h>

+ Inheritance diagram for ns3::ListErrorModel:

Public Member Functions

std::list< uint32_t > GetList (void) const
 
void SetList (const std::list< uint32_t > &packetlist)
 
- Public Member Functions inherited from ns3::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
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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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
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)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Types

typedef std::list< uint32_t > PacketList
 
typedef std::list< uint32_t >
::const_iterator 		PacketListCI
 

Private Member Functions

virtual bool DoCorrupt (Ptr< Packet > p)
 
virtual void DoReset (void)
 

Private Attributes

PacketList m_packetList
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoDispose (void)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

Provide a list of Packet uids to corrupt.

This object is used to flag packets as being lost/errored or not. A note on performance: the list is assumed to be unordered, and in general, Packet uids received may be unordered. Therefore, each call to IsCorrupt() will result in a walk of the list with the present underlying implementation.

Note also that if one wants to target multiple packets from looking at an (unerrored) trace file, the act of erroring a given packet may cause subsequent packet uids to change. For instance, suppose one wants to error packets 11 and 17 on a given device. It may be that erroring packet 11 will cause the subsequent uid stream to change and 17 may no longer correspond to the second packet that one wants to lose. Therefore, be advised that it might take some trial and error to select the right uids when multiple are provided.

Reset() on this model will clear the list

IsCorrupt() will not modify the packet data buffer

Config Paths

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

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

No Attributes are defined for this type.
No TraceSources are defined for this type.

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

Member Function Documentation

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

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

References NS_LOG_FUNCTION.

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

This method overwrites any previously provided list.

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

References NS_LOG_FUNCTION.

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