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
SimpleRefCount &	operator= (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::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

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

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

References NS_LOG_FUNCTION_NOARGS.

ns3::ListErrorModel::~ListErrorModel ( )

virtual

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

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

privatevirtual

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

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

Here is the call graph for this function:

void ns3::ListErrorModel::DoReset ( void )

privatevirtual

Definition at line 336 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 299 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]/$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.

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

References ns3::TypeId::SetParent().

Here is the call graph for this function: