DUNE PDELab (2.7)
Base class for composite nodes representing a filtered view on an underlying composite node. More...
#include <dune/typetree/filteredcompositenode.hh>
Classes | |
struct | Child |
Access to the type and storage type of the i-th child. More... | |
Public Types | |
typedef CompositeNodeTag | NodeTag |
The type tag that describes a CompositeNode. | |
typedef mapped_children::NodeStorage | NodeStorage |
The type used for storing the children. | |
typedef mapped_children::ChildTypes | ChildTypes |
A tuple storing the types of all children. | |
Public Member Functions | |
Child Access | |
template<std::size_t k> | |
std::enable_if< lazy_enable< k >::value, typenameChild< k >::Type & >::type | child (Dune::index_constant< k >={}) |
Returns the i-th child. More... | |
template<std::size_t k> | |
const Child< k >::Type & | child (Dune::index_constant< k >={}) const |
Returns the i-th child (const version). More... | |
template<std::size_t k> | |
std::enable_if< lazy_enable< k >::value, typenameChild< k >::Storage >::type | childStorage () |
Returns the storage of the i-th child. More... | |
template<std::size_t k> | |
Child< k >::ConstStorage | childStorage () const |
Returns the storage of the i-th child (const version). More... | |
template<std::size_t k> | |
void | setChild (typename Child< k >::type &child, typename std::enable_if< lazy_enable< k >::value, void * >::type=0) |
Sets the i-th child to the passed-in value. | |
template<std::size_t k> | |
void | setChild (typename Child< k >::storage_type child, typename std::enable_if< lazy_enable< k >::value, void * >::type=0) |
Sets the storage of the i-th child to the passed-in value. | |
Constructors | |
FilteredCompositeNode (std::shared_ptr< Node > node) | |
Initialize the CompositeNode with copies of the passed in Storage objects. | |
FilteredCompositeNode (Node &node) | |
Initialize the CompositeNode with a copy of the passed-in storage type. | |
Static Public Attributes | |
static const bool | isLeaf = false |
Mark this class as non leaf in the dune-typetree. | |
static const bool | isPower = false |
Mark this class as a non power in the dune-typetree. | |
static const bool | isComposite = true |
Mark this class as a composite in the dune-typetree. | |
static const std::size_t | CHILDREN = filter_result::size |
The number of children. | |
Protected Member Functions | |
Access to unfiltered node | |
template<bool enabled = !nodeIsConst> | |
std::enable_if< enabled, Node & >::type | unfiltered () |
Returns the unfiltered node. More... | |
const Node & | unfiltered () const |
Returns the unfiltered node (const version). More... | |
template<bool enabled = !nodeIsConst> | |
std::enable_if< enabled, std::shared_ptr< Node > >::type | unfilteredStorage () |
Returns the storage object of the unfiltered node. More... | |
std::shared_ptr< const Node > | unfilteredStorage () const |
Returns the storage object of the unfiltered node (const version). More... | |
Detailed Description
class Dune::TypeTree::FilteredCompositeNode< Node, Filter >
Base class for composite nodes representing a filtered view on an underlying composite node.
Member Function Documentation
◆ child() [1/2]
|
inline |
Returns the i-th child.
- Returns
- a reference to the i-th child.
Referenced by Dune::TypeTree::FilteredCompositeNode< Node, Filter >::setChild().
◆ child() [2/2]
|
inline |
Returns the i-th child (const version).
- Returns
- a const reference to the i-th child.
◆ childStorage() [1/2]
|
inline |
Returns the storage of the i-th child.
- Returns
- a copy of the object storing the i-th child.
◆ childStorage() [2/2]
|
inline |
Returns the storage of the i-th child (const version).
This method is only important if the child is stored as some kind of pointer, as this allows the pointee type to become const.
- Returns
- a copy of the object storing the i-th child.
◆ unfiltered() [1/2]
|
inlineprotected |
Returns the unfiltered node.
- Returns
- A reference to the original, unfiltered node.
◆ unfiltered() [2/2]
|
inlineprotected |
Returns the unfiltered node (const version).
- Returns
- A const reference to the original, unfiltered node.
◆ unfilteredStorage() [1/2]
|
inlineprotected |
Returns the storage object of the unfiltered node.
- Returns
- A shared_ptr to the original, unfiltered node.
◆ unfilteredStorage() [2/2]
|
inlineprotected |
Returns the storage object of the unfiltered node (const version).
- Returns
- A shared_ptr to the original, unfiltered node.
The documentation for this class was generated from the following file:
- dune/typetree/filteredcompositenode.hh
![Creative Commons License](https://i.creativecommons.org/l/by-sa/4.0/80x15.png)