A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::PacketBurst Class Reference

this class implement a burst as a list of packets More...

#include <packet-burst.h>

+ Inheritance diagram for ns3::PacketBurst:
+ Collaboration diagram for ns3::PacketBurst:

Public Member Functions

 PacketBurst (void)
 
virtual ~PacketBurst (void)
 
void AddPacket (Ptr< Packet > packet)
 add a packet to the list of packet More...
 
std::list< Ptr< Packet >
>::const_iterator 
Begin (void) const
 Returns an iterator to the begin of the burst. More...
 
Ptr< PacketBurstCopy (void) const
 
std::list< Ptr< Packet >
>::const_iterator 
End (void) const
 Returns an iterator to the end of the burst. More...
 
uint32_t GetNPackets (void) const
 
std::list< Ptr< Packet > > GetPackets (void) const
 
uint32_t GetSize (void) const
 
- 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)
 Get the type ID. More...
 
- 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 Member Functions

void DoDispose (void)
 This method is called by Object::Dispose or by the object's destructor, whichever comes first. More...
 

Private Attributes

std::list< Ptr< Packet > > m_packets
 the list of packets in the burst More...
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
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

this class implement a burst as a list of packets

Doxygen introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.

Definition at line 35 of file packet-burst.h.

Constructor & Destructor Documentation

ns3::PacketBurst::PacketBurst ( void  )

Definition at line 43 of file packet-burst.cc.

References NS_LOG_FUNCTION.

ns3::PacketBurst::~PacketBurst ( void  )
virtual

Definition at line 48 of file packet-burst.cc.

References list, m_packets, and NS_LOG_FUNCTION.

Member Function Documentation

void ns3::PacketBurst::AddPacket ( Ptr< Packet packet)

add a packet to the list of packet

Parameters
packetthe packet to add

Definition at line 81 of file packet-burst.cc.

References m_packets, and NS_LOG_FUNCTION.

Referenced by LteDownlinkDataSinrTestCase::DoRun(), and LteUplinkDataSinrTestCase::DoRun().

+ Here is the caller graph for this function:

std::list< Ptr< Packet > >::const_iterator ns3::PacketBurst::Begin ( void  ) const

Returns an iterator to the begin of the burst.

Returns
iterator to the burst list start

Definition at line 119 of file packet-burst.cc.

References m_packets, and NS_LOG_FUNCTION.

Ptr< PacketBurst > ns3::PacketBurst::Copy ( void  ) const
Returns
a copy the packetBurst

Definition at line 66 of file packet-burst.cc.

References ns3::Packet::Copy(), list, m_packets, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

void ns3::PacketBurst::DoDispose ( void  )
privatevirtual

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

It is safe to call GetObject from within this method.

Reimplemented from ns3::Object.

Definition at line 60 of file packet-burst.cc.

References m_packets, and NS_LOG_FUNCTION.

std::list< Ptr< Packet > >::const_iterator ns3::PacketBurst::End ( void  ) const

Returns an iterator to the end of the burst.

Returns
iterator to the burst list end

Definition at line 126 of file packet-burst.cc.

References m_packets, and NS_LOG_FUNCTION.

uint32_t ns3::PacketBurst::GetNPackets ( void  ) const
Returns
the number of packet in the burst

Definition at line 98 of file packet-burst.cc.

References m_packets, and NS_LOG_FUNCTION.

std::list< Ptr< Packet > > ns3::PacketBurst::GetPackets ( void  ) const
Returns
the list of packet of this burst

Definition at line 91 of file packet-burst.cc.

References m_packets, and NS_LOG_FUNCTION.

Referenced by ns3::PcapSniffTxRxEvent().

+ Here is the caller graph for this function:

uint32_t ns3::PacketBurst::GetSize ( void  ) const
Returns
the size of the burst in byte (the size of all packets)

Definition at line 105 of file packet-burst.cc.

References ns3::Packet::GetSize(), list, m_packets, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

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

Get the type ID.

Returns
the object TypeId

Definition at line 34 of file packet-burst.cc.

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

Member Data Documentation

std::list<Ptr<Packet> > ns3::PacketBurst::m_packets
private

the list of packets in the burst

Definition at line 79 of file packet-burst.h.

Referenced by AddPacket(), Begin(), Copy(), DoDispose(), End(), GetNPackets(), GetPackets(), GetSize(), and ~PacketBurst().


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