DTN::BundlePointer Class Reference

A reference into a BundleStore. More...

#include <dtn/BundlePointer.h>

Collaboration diagram for DTN::BundlePointer:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BundlePointer (BundlePointerRepr *repr=0)
 Constructor taking an iterator.
 BundlePointer (const BundlePointer &aOther)
 Copy constructor.
virtual ~BundlePointer ()
 Virtual destructor.
void operator= (const BundlePointer &aOther)
 Assignment operator.
bool operator== (const BundlePointer &bp)
 Equality operator.
bool isNull () const
 
Returns:
whether this is a NULL pointer

const BundlePointerReprrepr () const
 
Returns:
the internal iterator

BundlePointer next ()
 
Returns:
a new BundlePointer that follows this one in the store, or a NULL pointer if already at the end

const BundlePointer next () const
 
Returns:
a new BundlePointer that follows this one in the store, or a NULL pointer if already at the end


Detailed Description

A reference into a BundleStore.

This class provides the mechanisms for a policy object to examine the contents of a BundleStore. Some policies might keep caches of BundlePointers for faster lookup.

Definition at line 96 of file BundlePointer.h.


Constructor & Destructor Documentation

BundlePointer::BundlePointer ( BundlePointerRepr repr = 0  ) 

Constructor taking an iterator.

If no argument is provided, a NULL BundlePointer is created.

Parameters:
repr The iterator to store, taking ownership of the memory

Definition at line 35 of file BundlePointer.cc.

Referenced by next().


Member Function Documentation

bool BundlePointer::operator== ( const BundlePointer bp  ) 

Equality operator.

Two BundlePointers are equal if and only if they refer to the same Bundle.

Parameters:
bp Another pointer
Note:
A NULL pointer is defined to be not equal to any other pointer, including another NULL pointer.

Definition at line 77 of file BundlePointer.cc.

References isNull(), and m_repr.


The documentation for this class was generated from the following files:
Generated on Mon Mar 24 11:15:48 2008 for Pydtn Simulator by  doxygen 1.5.4