ns3::TagIterator::Item Class Reference

#include <packet.h>

Collaboration diagram for ns3::TagIterator::Item:
Collaboration graph
[legend]

List of all members.

Public Member Functions

TypeId GetTypeId (void) const
uint32_t GetStart (void) const
uint32_t GetEnd (void) const
void GetTag (Tag &tag) const

Private Member Functions

 Item (TypeId tid, uint32_t start, uint32_t end, TagBuffer buffer)

Private Attributes

TypeId m_tid
uint32_t m_start
uint32_t m_end
TagBuffer m_buffer

Friends

class TagIterator

Detailed Description

Identifies a tag and a set of bytes within a packet to which the tag applies.

Definition at line 55 of file packet.h.


Constructor & Destructor Documentation

ns3::TagIterator::Item::Item ( TypeId  tid,
uint32_t  start,
uint32_t  end,
TagBuffer  buffer 
) [private]

Definition at line 54 of file packet.cc.


Member Function Documentation

uint32_t ns3::TagIterator::Item::GetEnd ( void   )  const
Returns:
the index of the last byte tagged by this tag.

The index is an offset from the start of the packet.

Definition at line 41 of file packet.cc.

References m_end.

Referenced by ns3::PacketTest::DoCheck(), and ns3::Packet::PrintTags().

uint32_t ns3::TagIterator::Item::GetStart ( void   )  const
Returns:
the index of the first byte tagged by this tag.

The index is an offset from the start of the packet.

Definition at line 36 of file packet.cc.

References m_start.

Referenced by ns3::PacketTest::DoCheck(), and ns3::Packet::PrintTags().

void ns3::TagIterator::Item::GetTag ( Tag tag  )  const
Parameters:
tag the user tag to which the data should be copied.

Read the requested tag and store it in the user-provided tag instance. This method will crash if the type of the tag provided by the user does not match the type of the underlying tag.

Definition at line 46 of file packet.cc.

References ns3::Tag::Deserialize(), ns3::ObjectBase::GetInstanceTypeId(), GetTypeId(), m_buffer, and NS_FATAL_ERROR.

Referenced by ns3::PacketTest::DoCheck(), ns3::Packet::FindFirstMatchingTag(), and ns3::Packet::PrintTags().

TypeId ns3::TagIterator::Item::GetTypeId ( void   )  const
Returns:
the ns3::TypeId associated to this tag.

Definition at line 31 of file packet.cc.

References m_tid.

Referenced by ns3::PacketTest::DoCheck(), ns3::Packet::FindFirstMatchingTag(), GetTag(), and ns3::Packet::PrintTags().


Friends And Related Function Documentation

friend class TagIterator [friend]

Definition at line 84 of file packet.h.


Member Data Documentation

Definition at line 89 of file packet.h.

Referenced by GetTag().

uint32_t ns3::TagIterator::Item::m_end [private]

Definition at line 88 of file packet.h.

Referenced by GetEnd().

uint32_t ns3::TagIterator::Item::m_start [private]

Definition at line 87 of file packet.h.

Referenced by GetStart().

Definition at line 86 of file packet.h.

Referenced by GetTypeId().


The documentation for this class was generated from the following files:
Generated on Thu Dec 3 14:09:59 2009 for NS-3 by  doxygen 1.6.3