#include <node_iterator.hpp>

Inheritance diagram for hdf5::node::NodeIterator:

Collaboration diagram for hdf5::node::NodeIterator:

Public Types
using	value_type = Node

using	pointer = value_type *

using	reference = value_type &

using	difference_type = ssize_t

using	iterator_category = std::bidirectional_iterator_tag

Public Member Functions
	NodeIterator ()=delete
	default constructor More...

Node	operator* () const

Node *	operator-> ()

NodeIterator &	operator++ ()

NodeIterator	operator++ (int)

NodeIterator &	operator-- ()

NodeIterator	operator-- (int)

bool	operator== (const NodeIterator &a) const

bool	operator!= (const NodeIterator &a) const

Public Member Functions inherited from hdf5::Iterator
	Iterator ()
	default constructor More...

	Iterator (ssize_t index)

	Iterator (const Iterator &)=default

Iterator &	operator= (const Iterator &)=default

virtual	~Iterator ()

Iterator &	operator++ ()
	increment iterator position More...

Iterator &	operator-- ()

Iterator	operator++ (int)

Iterator	operator-- (int)

Iterator &	operator+= (ssize_t i)

Iterator &	operator-= (ssize_t i)

bool	operator== (const Iterator &b) const

bool	operator< (const Iterator &b) const

bool	operator<= (const Iterator &b) const

bool	operator> (const Iterator &b) const

bool	operator>= (const Iterator &b) const

ssize_t	index () const
	get state of the iterator More...

Static Public Member Functions
static NodeIterator	begin (const Group &group)
	get iterator to first element More...

static NodeIterator	end (const Group &group)
	get iterator to last+1 element More...

Detailed Description

This iterator iterates over the direct children (nodes) of a group. It is a full random access iterator using the index access methods provided by the NodeView interface.

The interface follows the C++ specification for bidirectional constant iterators. See C++ reference on iterators for details.

Member Typedef Documentation

◆ difference_type

using hdf5::node::NodeIterator::difference_type = ssize_t

◆ iterator_category

using hdf5::node::NodeIterator::iterator_category = std::bidirectional_iterator_tag

◆ pointer

using hdf5::node::NodeIterator::pointer = value_type*

◆ reference

using hdf5::node::NodeIterator::reference = value_type&

◆ value_type

using hdf5::node::NodeIterator::value_type = Node

Constructor & Destructor Documentation

◆ NodeIterator()

hdf5::node::NodeIterator::NodeIterator ( )

delete

Not requried, thus deleted.

Member Function Documentation

◆ begin()

static NodeIterator hdf5::node::NodeIterator::begin ( const Group & group )

static

Static factory function returning an iterator to the first child of a group.

Parameters

group reference to the group over which to iterate

Returns: instance of NodeIterator

◆ end()

static NodeIterator hdf5::node::NodeIterator::end ( const Group & group )

static

Static factory function returning an iterator to the last+1 child of the given group.

Parameters

group reference to the group over which to iterate

Returns: instance of NodeIterator

◆ operator!=()

bool hdf5::node::NodeIterator::operator!= ( const NodeIterator & a ) const

◆ operator*()

Node hdf5::node::NodeIterator::operator* ( ) const

◆ operator++() [1/2]

NodeIterator& hdf5::node::NodeIterator::operator++ ( )

◆ operator++() [2/2]

NodeIterator hdf5::node::NodeIterator::operator++ ( int )

◆ operator--() [1/2]

NodeIterator& hdf5::node::NodeIterator::operator-- ( )

◆ operator--() [2/2]

NodeIterator hdf5::node::NodeIterator::operator-- ( int )

◆ operator->()

Node* hdf5::node::NodeIterator::operator-> ( )

◆ operator==()

bool hdf5::node::NodeIterator::operator== ( const NodeIterator & a ) const

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

/home/jenkins/h5cpp/src/h5cpp/node/node_iterator.hpp

Public Types

Public Member Functions

Static Public Member Functions