ns3::ListErrorModel Class Reference

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

#include <error-model.h>

Inheritance diagram for ns3::ListErrorModel:
Inheritance graph
[legend]
Collaboration diagram for ns3::ListErrorModel:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 ListErrorModel ()
virtual ~ListErrorModel ()
std::list< uint32_t > GetList (void) const
void SetList (const std::list< uint32_t > &packetlist)

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::ListErrorModel.

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

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

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


Member Typedef Documentation

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

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

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

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


Constructor & Destructor Documentation

ns3::ListErrorModel::ListErrorModel (  ) 

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

References NS_LOG_FUNCTION_NOARGS.

ns3::ListErrorModel::~ListErrorModel (  )  [virtual]

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

References NS_LOG_FUNCTION_NOARGS.


Member Function Documentation

bool ns3::ListErrorModel::DoCorrupt ( Ptr< Packet p  )  [private, virtual]

Implements ns3::ErrorModel.

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

References ns3::ErrorModel::IsEnabled(), m_packetList, and NS_LOG_FUNCTION_NOARGS.

void ns3::ListErrorModel::DoReset ( void   )  [private, virtual]

Implements ns3::ErrorModel.

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

References m_packetList, and NS_LOG_FUNCTION_NOARGS.

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

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

References m_packetList, and NS_LOG_FUNCTION_NOARGS.

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

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

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3CsmaNetDevice/ReceiveErrorModel/$ns3ListErrorModel
  • /NodeList/[i]/DeviceList/[i]/$ns3PointToPointNetDevice/ReceiveErrorModel/$ns3ListErrorModel

No Attributes 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 defined for this type.

Reimplemented from ns3::ErrorModel.

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

References ns3::TypeId::SetParent().

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

This method overwrites any previously provided list.

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

References m_packetList, and NS_LOG_FUNCTION_NOARGS.


Member Data Documentation

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

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


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:09:57 2009 for NS-3 by  doxygen 1.6.3