OpenNI 1.5.4
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
XnHash::ConstIterator Class Reference

#include <XnHash.h>

Inheritance diagram for XnHash::ConstIterator:
Inheritance graph
[legend]

Public Member Functions

 ConstIterator (const ConstIterator &other)
 
ConstIteratoroperator++ ()
 
ConstIterator operator++ (int)
 
ConstIteratoroperator-- ()
 
ConstIterator operator-- (int)
 
XnBool operator== (const ConstIterator &other) const
 
XnBool operator!= (const ConstIterator &other) const
 
const XnKeyKey () const
 
const XnValueValue () const
 
XnNodeGetNode ()
 
const XnNodeGetNode () const
 

Protected Member Functions

 ConstIterator (const XnHash *pHash, XnUInt16 nBin, XnList::Iterator listIterator)
 
 ConstIterator (const XnHash *pHash)
 

Protected Attributes

const XnHashm_pHash
 
XnUInt16 m_nCurrentBin
 
XnList::Iterator m_Iterator
 

Friends

class XnHash
 

Detailed Description

Iterator to the XnHash

Constructor & Destructor Documentation

XnHash::ConstIterator::ConstIterator ( const ConstIterator other)
inline

Copy constructor

Parameters
other[in] instance to copy from
XnHash::ConstIterator::ConstIterator ( const XnHash pHash,
XnUInt16  nBin,
XnList::Iterator  listIterator 
)
inlineprotected

constructor to be used from inside the XnHash

Parameters
pHash[in] The hash to which the iterator belongs
nBin[in] The bin of the current object
listIterator[in] Iterator on the bin (each bin is a XnList)
XnHash::ConstIterator::ConstIterator ( const XnHash pHash)
inlineprotected

constructor to be used from inside the XnHash. It points to the first value in the hash.

Parameters
pHash[in] The hash to which the iterator belongs

Member Function Documentation

XnNode* XnHash::ConstIterator::GetNode ( )
inline

Get the entire current object (non-const version)

const XnNode* XnHash::ConstIterator::GetNode ( ) const
inline

Get the entire current object (const version)

const XnKey& XnHash::ConstIterator::Key ( ) const
inline

Get the key of the current object (const version)

XnBool XnHash::ConstIterator::operator!= ( const ConstIterator other) const
inline

Operator to check if 2 iterators point to different objects

Parameters
other[in] instance to compare with
ConstIterator& XnHash::ConstIterator::operator++ ( )
inline

Support ++iterator, go to the next object in the hash

ConstIterator XnHash::ConstIterator::operator++ ( int  )
inline

Support iterator++, go to the next object in the hash, returning the old value

ConstIterator& XnHash::ConstIterator::operator-- ( )
inline

Support –iterator, go to the previous object in the hash

ConstIterator XnHash::ConstIterator::operator-- ( int  )
inline

Support iterator–, go to the previous object in the hash, returning the old value

XnBool XnHash::ConstIterator::operator== ( const ConstIterator other) const
inline

Operator to check if 2 iterators point to the same object

Parameters
other[in] instance to compare with
const XnValue& XnHash::ConstIterator::Value ( ) const
inline

Get the value of the current object (const version)

Friends And Related Function Documentation

friend class XnHash
friend

Member Data Documentation

XnList::Iterator XnHash::ConstIterator::m_Iterator
protected

Iterator for the specific bin

XnUInt16 XnHash::ConstIterator::m_nCurrentBin
protected

The bin of the current object

const XnHash* XnHash::ConstIterator::m_pHash
protected

The hash to which the iterator belongs


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