Dune Core Modules (2.8.0)

Dune::TypeTree::TreeVisitor Struct Reference

Convenience base class for visiting the entire tree. More...

#include <dune/typetree/visitor.hh>

Public Member Functions

template<typename T , typename TreePath >
void pre (T &&t, TreePath treePath) const
 Method for prefix tree traversal. More...
 
template<typename T , typename TreePath >
void in (T &&t, TreePath treePath) const
 Method for infix tree traversal. More...
 
template<typename T , typename TreePath >
void post (T &&t, TreePath treePath) const
 Method for postfix tree traversal. More...
 
template<typename T , typename TreePath >
void leaf (T &&t, TreePath treePath) const
 Method for leaf traversal. More...
 
template<typename T , typename Child , typename TreePath , typename ChildIndex >
void beforeChild (T &&t, Child &&child, TreePath treePath, ChildIndex childIndex) const
 Method for parent-child traversal. More...
 
template<typename T , typename Child , typename TreePath , typename ChildIndex >
void afterChild (T &&t, Child &&child, TreePath treePath, ChildIndex childIndex) const
 Method for child-parent traversal. More...
 

Detailed Description

Convenience base class for visiting the entire tree.

Member Function Documentation

◆ afterChild()

template<typename T , typename Child , typename TreePath , typename ChildIndex >
void Dune::TypeTree::DefaultVisitor::afterChild ( T &&  t,
Child &&  child,
TreePath  treePath,
ChildIndex  childIndex 
) const
inlineinherited

Method for child-parent traversal.

This method gets called after visiting a child node.

Note
This method gets called even if the child node was not visited because the visitor chose not to do so.
Parameters
tThe parent node.
childThe child node that was visited last (if the visitor did not reject it).
treePathThe position of the parent node within the TypeTree.
childIndexThe index of the child node in relation to the parent node.

◆ beforeChild()

template<typename T , typename Child , typename TreePath , typename ChildIndex >
void Dune::TypeTree::DefaultVisitor::beforeChild ( T &&  t,
Child &&  child,
TreePath  treePath,
ChildIndex  childIndex 
) const
inlineinherited

Method for parent-child traversal.

This method gets called before visiting a child node.

Note
This method gets called even if the visitor decides not to visit the child in question.
Parameters
tThe parent node.
childThe child node that will (potentially) be visited next.
treePathThe position of the parent node within the TypeTree.
childIndexThe index of the child node in relation to the parent node.

◆ in()

template<typename T , typename TreePath >
void Dune::TypeTree::DefaultVisitor::in ( T &&  t,
TreePath  treePath 
) const
inlineinherited

Method for infix tree traversal.

This method gets called BETWEEN visits of children of a non-leaf node. That definition implies that this method will only be called for nodes with at least two children.

Parameters
tThe node to visit.
treePathThe position of the node within the TypeTree.

◆ leaf()

template<typename T , typename TreePath >
void Dune::TypeTree::DefaultVisitor::leaf ( T &&  t,
TreePath  treePath 
) const
inlineinherited

Method for leaf traversal.

This method gets called when encountering a leaf node within the TypeTree.

Parameters
tThe node to visit.
treePathThe position of the node within the TypeTree.

◆ post()

template<typename T , typename TreePath >
void Dune::TypeTree::DefaultVisitor::post ( T &&  t,
TreePath  treePath 
) const
inlineinherited

Method for postfix tree traversal.

This method gets called after all children of a non-leaf node have been visited.

Parameters
tThe node to visit.
treePathThe position of the node within the TypeTree.

◆ pre()

template<typename T , typename TreePath >
void Dune::TypeTree::DefaultVisitor::pre ( T &&  t,
TreePath  treePath 
) const
inlineinherited

Method for prefix tree traversal.

This method gets called when first encountering a non-leaf node and before visiting any of its children.

Parameters
tThe node to visit.
treePathThe position of the node within the TypeTree.

The documentation for this struct was generated from the following file:
Creative Commons License   |  Legal Statements / Impressum  |  Hosted by TU Dresden  |  generated with Hugo v0.111.3 (Nov 21, 23:30, 2024)