PST File Format SDK v0.4
Loading...
Searching...
No Matches
pstsdk::const_btree_node_iter< K, V > Class Template Reference

The actual iterator type used by the btree_node class hierarchy. More...

#include <btree.h>

+ Inheritance diagram for pstsdk::const_btree_node_iter< K, V >:
+ Collaboration diagram for pstsdk::const_btree_node_iter< K, V >:

Public Member Functions

 const_btree_node_iter ()
 Default constructor.
 
 const_btree_node_iter (const btree_node< K, V > *root, bool last)
 Constructs an iterator from a root node.
 

Friends

class boost::iterator_core_access
 

Detailed Description

template<typename K, typename V>
class pstsdk::const_btree_node_iter< K, V >

The actual iterator type used by the btree_node class hierarchy.

We use the boost iterator library here to implement our iterator. All of the actual iteration logic is contained in the first, last, next, and prev member functions of the btree_node classes. They know how to modify the btree_iter_impl state class to move between various btree pages. The iterator class itself therefore is very light weight.

Parameters
Kkey type
Vvalue type

Definition at line 228 of file btree.h.

Constructor & Destructor Documentation

◆ const_btree_node_iter() [1/2]

template<typename K , typename V >
pstsdk::const_btree_node_iter< K, V >::const_btree_node_iter ( )

Default constructor.

Definition at line 425 of file btree.h.

◆ const_btree_node_iter() [2/2]

template<typename K , typename V >
pstsdk::const_btree_node_iter< K, V >::const_btree_node_iter ( const btree_node< K, V > *  root,
bool  last 
)

Constructs an iterator from a root node.

Parameters
[in]rootThe root of the BTree to iterator over
[in]lastTrue if this is a begin iterator, false for an end iterator

Definition at line 432 of file btree.h.

Friends And Related Symbol Documentation

◆ boost::iterator_core_access

template<typename K , typename V >
friend class boost::iterator_core_access
friend

Definition at line 240 of file btree.h.


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