A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
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)
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)
 This method returns the TypeId associated to ns3::ReceiveListErrorModel.

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
uint32_t m_timesInvoked

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 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

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

Member Typedef Documentation

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

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

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

Constructor & Destructor Documentation

ns3::ReceiveListErrorModel::ReceiveListErrorModel ( )

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

References NS_LOG_FUNCTION_NOARGS.

ns3::ReceiveListErrorModel::~ReceiveListErrorModel ( )
virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

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

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

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

+ Here is the call graph for this function:

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

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

References m_packetList, and NS_LOG_FUNCTION_NOARGS.

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

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

References m_packetList, and NS_LOG_FUNCTION_NOARGS.

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

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

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

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

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 348 of file error-model.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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 377 of file error-model.cc.

References m_packetList, and NS_LOG_FUNCTION_NOARGS.

Referenced by NscTcpLossTestCase1::DoRun(), Ns3TcpLossTestCase::DoRun(), Ns3TcpStateTestCase::DoRun(), and NscTcpLossTestCase2::DoRun().

+ Here is the caller graph for this function:

Member Data Documentation

PacketList ns3::ReceiveListErrorModel::m_packetList
private

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

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

uint32_t ns3::ReceiveListErrorModel::m_timesInvoked
private

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

Referenced by DoCorrupt().


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