A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::ListErrorModel Class Reference

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

#include <error-model.h>

+ Inheritance diagram for ns3::ListErrorModel:
+ Collaboration diagram for ns3::ListErrorModel:

Public Member Functions

 ListErrorModel ()
virtual ~ListErrorModel ()
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)
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
SimpleRefCountoperator= (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)

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 DoStart (void)
virtual void NotifyNewAggregate (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 248 of file error-model.h.

Member Typedef Documentation

typedef std::list<uint32_t> ns3::ListErrorModel::PacketList
private

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

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

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

Constructor & Destructor Documentation

ns3::ListErrorModel::ListErrorModel ( )

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

References NS_LOG_FUNCTION.

ns3::ListErrorModel::~ListErrorModel ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

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

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

+ Here is the call graph for this function:

void ns3::ListErrorModel::DoReset ( void  )
privatevirtual

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

References m_packetList, and NS_LOG_FUNCTION.

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

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

References m_packetList, and NS_LOG_FUNCTION.

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

Reimplemented from ns3::ErrorModel.

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this 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 307 of file error-model.cc.

References m_packetList, and NS_LOG_FUNCTION.

Member Data Documentation

PacketList ns3::ListErrorModel::m_packetList
private

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

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


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