ns3::PbbAddressTlvBlock Class Reference

A block of Address TLVs (PbbAddressTlv). More...

#include <packetbb.h>

List of all members.

Public Types
typedef std::list< Ptr < PbbAddressTlv > >::iterator	Iterator
typedef std::list< Ptr < PbbAddressTlv > >::const_iterator	ConstIterator
Public Member Functions
Iterator	Begin (void)
ConstIterator	Begin (void) const
Iterator	End (void)
ConstIterator	End (void) const
int	Size (void) const
bool	Empty (void) const
Ptr< PbbAddressTlv >	Front (void) const
Ptr< PbbAddressTlv >	Back (void) const
void	PushFront (Ptr< PbbAddressTlv > tlv)
	Prepends an Address TLV to the front of this block.
void	PopFront (void)
	Removes an AddressTLV from the front of this block.
void	PushBack (Ptr< PbbAddressTlv > tlv)
	Appends an Address TLV to the back of this block.
void	PopBack (void)
	Removes an Address TLV from the back of this block.
Iterator	Insert (Iterator position, const Ptr< PbbAddressTlv > tlv)
	Inserts an Address TLV at the specified position in this block.
Iterator	Erase (Iterator position)
	Removes the Address TLV at the specified position.
Iterator	Erase (Iterator first, Iterator last)
	Removes all Address TLVs from [first, last) (includes first, not includes last).
void	Clear (void)
	Removes all Address TLVs from this block.
uint32_t	GetSerializedSize (void) const
void	Serialize (Buffer::Iterator &start) const
	Serializes this block into the specified buffer.
void	Deserialize (Buffer::Iterator &start)
	Deserializes a block from the specified buffer.
void	Print (std::ostream &os) const
	Pretty-prints the contents of this block.
void	Print (std::ostream &os, int level) const
	Pretty-prints the contents of this block, with specified indentation.
bool	operator== (const PbbAddressTlvBlock &other) const
bool	operator!= (const PbbAddressTlvBlock &other) const

---

Detailed Description

A block of Address TLVs (PbbAddressTlv).

Acts similar to a C++ STL container.

---

Member Function Documentation

Ptr<PbbAddressTlv> ns3::PbbAddressTlvBlock::Back

(

void

)

const

Returns:

the last AddressTLV in this block.

Iterator ns3::PbbAddressTlvBlock::Begin

(

void

)

Returns:

an iterator to the first Address TLV in this block.

ConstIterator ns3::PbbAddressTlvBlock::Begin

(

void

)

const

Returns:

a const iterator to the first Address TLV in this block.

void ns3::PbbAddressTlvBlock::Deserialize

(

Buffer::Iterator &

start

)

Deserializes a block from the specified buffer.

Parameters:

start

a reference to the point in a buffer to begin deserializing.

Users should not need to call this. Blocks will be deserialized by their containing packet.

bool ns3::PbbAddressTlvBlock::Empty

(

void

)

const

Returns:

true if there are no Address TLVs in this block, false otherwise.

ConstIterator ns3::PbbAddressTlvBlock::End

(

void

)

const

Returns:

a const iterator to the past-the-end element in this block.

Iterator ns3::PbbAddressTlvBlock::End

(

void

)

Returns:

an iterator to the past-the-end element in this block.

Iterator ns3::PbbAddressTlvBlock::Erase

(

Iterator

position

)

Removes the Address TLV at the specified position.

Parameters:

position

an Iterator pointing to the Address TLV to erase.

Returns:

an iterator pointing to the next Address TLV in the block.

Iterator ns3::PbbAddressTlvBlock::Erase	(	Iterator	first,
		Iterator	last
	)

Removes all Address TLVs from [first, last) (includes first, not includes last).

Parameters:

	first	an Iterator pointing to the first Address TLV to erase (inclusive).
	last	an Iterator pointing to the element past the last Address TLV to erase.

Returns:

an iterator pointing to the next Address TLV in the block.

Ptr<PbbAddressTlv> ns3::PbbAddressTlvBlock::Front

(

void

)

const

Returns:

the first Address TLV in this block.

uint32_t ns3::PbbAddressTlvBlock::GetSerializedSize

(

void

)

const

Returns:

The size (in bytes) needed to serialize this block.

Iterator ns3::PbbAddressTlvBlock::Insert	(	Iterator	position,
		const Ptr< PbbAddressTlv >	tlv
	)

Inserts an Address TLV at the specified position in this block.

Parameters:

	position	an Iterator pointing to the position in this block to insert the Address TLV.
	tlv	a smart pointer to the Address TLV to insert.

Returns:

An iterator pointing to the newly inserted Address TLV.

void ns3::PbbAddressTlvBlock::Print	(	std::ostream &	os,
		int	level
	)			const

Pretty-prints the contents of this block, with specified indentation.

Parameters:

	os	a stream object to print to.
	level	level of indentation.

This probably never needs to be called by users. This is used when recursively printing sub-objects.

void ns3::PbbAddressTlvBlock::Print

(

std::ostream &

os

)

const

Pretty-prints the contents of this block.

Parameters:

os

a stream object to print to.

void ns3::PbbAddressTlvBlock::PushBack

(

Ptr< PbbAddressTlv >

tlv

)

Appends an Address TLV to the back of this block.

Parameters:

tlv

a smart pointer to the Address TLV to append.

void ns3::PbbAddressTlvBlock::PushFront

(

Ptr< PbbAddressTlv >

tlv

)

Prepends an Address TLV to the front of this block.

Parameters:

tlv

a smart pointer to the Address TLV to prepend.

void ns3::PbbAddressTlvBlock::Serialize

(

Buffer::Iterator &

start

)

const

Serializes this block into the specified buffer.

Parameters:

start

a reference to the point in a buffer to begin serializing.

Users should not need to call this. Blocks will be serialized by their containing packet.

int ns3::PbbAddressTlvBlock::Size

(

void

)

const

Returns:

the number of Address TLVs in this block.

---

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

• src/node/packetbb.h