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)
 Disable the error model. More...
 
void Enable (void)
 Enable the error model. More...
 
bool IsCorrupt (Ptr< Packet > pkt)
 Note: Depending on the error model, this function may or may not alter the contents of the packet upon returning true. More...
 
bool IsEnabled (void) const
 
void Reset (void)
 Reset any state associated with the error model. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 
virtual ~Object ()
 
void AggregateObject (Ptr< Object > other)
 
void Dispose (void)
 Run the DoDispose methods of this object and all the objects aggregated to it. More...
 
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)
 This method calls the virtual DoInitialize method on all the objects aggregated to this object. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
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)
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 Noop. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 Get the type ID. More...
 

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)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 
virtual void DoInitialize (void)
 This method is called only once by Object::Initialize. More...
 
virtual void NotifyNewAggregate (void)
 This method is invoked whenever two sets of objects are aggregated together. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 This method is invoked once all member attributes have been initialized. More...
 

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

Config Paths

ns3::ReceiveListErrorModel 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 are defined for this type.
No TraceSources are defined for this type.

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

Member Typedef Documentation

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

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

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

Constructor & Destructor Documentation

ns3::ReceiveListErrorModel::ReceiveListErrorModel ( )

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

References NS_LOG_FUNCTION.

ns3::ReceiveListErrorModel::~ReceiveListErrorModel ( )
virtual

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

References NS_LOG_FUNCTION.

Member Function Documentation

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

Implements ns3::ErrorModel.

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

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

+ Here is the call graph for this function:

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

Implements ns3::ErrorModel.

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

References m_packetList, and NS_LOG_FUNCTION.

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

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

References m_packetList, and NS_LOG_FUNCTION.

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

Definition at line 491 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 520 of file error-model.cc.

References m_packetList, and NS_LOG_FUNCTION.

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

+ Here is the caller graph for this function:

Member Data Documentation

PacketList ns3::ReceiveListErrorModel::m_packetList
private

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

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

uint32_t ns3::ReceiveListErrorModel::m_timesInvoked
private

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

Referenced by DoCorrupt().


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