ns-3
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:

List of all members.

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
bool IsCorrupt (Ptr< Packet > pkt)
void Reset (void)
void Enable (void)
void Disable (void)
bool IsEnabled (void) const
- Public Member Functions inherited from ns3::Object
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Dispose (void)
void AggregateObject (Ptr< Object > other)
AggregateIterator GetAggregateIterator (void) const
void Start (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount (const SimpleRefCount &o)
SimpleRefCountoperator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
uint32_t GetReferenceCount (void) const
- Public Member Functions inherited from ns3::ObjectBase
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
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::ListErrorModel.

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


Member Function Documentation

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

References 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]/$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 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.

References ns3::TypeId::SetParent().

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.

References NS_LOG_FUNCTION_NOARGS.


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