Mirror reflection library 0.5.13

mirror::Traversal Struct Reference

Traversal allows to traverse elements of containers in an uniform way. More...

#include <mirror/doc/concepts_container.hpp>

List of all members.

Public Member Functions

bool done (void) const
 Indicates that the element traversal is finished.
bool empty (void) const
 Synonym for done.
SafeLocator front (void) const
 Returns a locator for the current element in the traversal.
void step_front (void)
 Moves the front of the range one step ahead, to the next element.

Detailed Description

Traversal allows to traverse elements of containers in an uniform way.

Traversal is not a meta-object, it is rather an abstraction for types wrapping various methods of container element traversal. Instances of these types are created by the MetaTraversal meta-object and allow the users to iterate through the elements of an arbitrary container in a generic way.

See also:
MetaTraversal

Member Function Documentation

bool mirror::Traversal::done ( void  ) const

Indicates that the element traversal is finished.

When this member function returns true, then the step_front and the front member functions must not be called.

See also:
empty
SafeLocator mirror::Traversal::front ( void  ) const

Returns a locator for the current element in the traversal.

This function should not be called if done() returns true.

See also:
done
void mirror::Traversal::step_front ( void  )

Moves the front of the range one step ahead, to the next element.

This function should not be called if done() returns true.

See also:
done

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

Copyright © 2006-2011 Matus Chochlik, University of Zilina, Zilina, Slovakia.
<matus.chochlik -at- fri.uniza.sk>
<chochlik -at -gmail.com>
Documentation generated on Fri Dec 16 2011 by Doxygen (version 1.7.3).
Important note: Although the 'boostified' version of Mirror uses the Boost C++ libraries Coding Guidelines and is implemented inside of the boost namespace, it IS NOT an officially reviewed and accepted Boost library. Mirror is being developed with the intention to be submitted for review for inclusion to the Boost C++ libraries.