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

#include <introspected-doxygen.h>

+ Inheritance diagram for ns3::PacketBurst:

Public Member Functions

void AddPacket (Ptr< Packet > packet)
 add a packet to the list of packet More...
 
std::list< Ptr< Packet >
>::const_iterator 
Begin (void) const
 
Ptr< PacketBurstCopy (void) const
 
std::list< Ptr< Packet >
>::const_iterator 
End (void) const
 
uint32_t GetNPackets (void) const
 
std::list< Ptr< Packet > > GetPackets (void) const
 
uint32_t GetSize (void) const
 
- Public Member Functions inherited from ns3::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 Initialize (void)
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 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
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 class implement a burst as a list of packets
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

void DoDispose (void)
 

Private Attributes

std::list< Ptr< Packet > > m_packets
 

Additional Inherited Members

- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

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 32 of file packet-burst.h.

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 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(), and NS_LOG_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 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 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 NS_LOG_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(), and NS_LOG_FUNCTION.


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