concepts::ElementPairList< F > Class Template Reference
Holds a list of ElementPair
and allows to scan over this list.
More...
#include <elementPairs.hh>
Public Types | |
typedef concepts::Scan< ElementPair< F > > | Scanner |
Public Member Functions | |
void | add (ElementPair< F > *elmPair) |
Adds the new ElementPair to the beginning of the list. More... | |
ElementPairList (concepts::Joiner< ElementPair< F > *, 1 > *elmPairs=0, bool remove=true) | |
Constructor. More... | |
Scanner * | scan () const |
Returns a scanner over the list of ElementPairs . More... | |
~ElementPairList () | |
Private Attributes | |
concepts::Joiner< ElementPair< F > *, 1 > * | elmPairs_ |
List of ElementPairs . More... | |
const bool | remove_ |
Detailed Description
template<typename F>
class concepts::ElementPairList< F >
Holds a list of ElementPair
and allows to scan over this list.
Definition at line 41 of file elementPairs.hh.
Member Typedef Documentation
◆ Scanner
typedef concepts::Scan<ElementPair<F> > concepts::ElementPairList< F >::Scanner |
Definition at line 43 of file elementPairs.hh.
Constructor & Destructor Documentation
◆ ElementPairList()
|
inline |
Constructor.
Usually, the list is removed by this class. If remove
is set to false
, this is not the case. Beware: this option holds also for pairs which are added later to elmPairs_
using add
.
- Parameters
-
elmPairs List of element pairs remove Should elmPairs_
be removed at the end?
Definition at line 52 of file elementPairs.hh.
◆ ~ElementPairList()
|
inline |
Definition at line 56 of file elementPairs.hh.
Member Function Documentation
◆ add()
|
inline |
Adds the new ElementPair
to the beginning of the list.
This class takes care of removing elmPair
at the end.
Definition at line 63 of file elementPairs.hh.
◆ scan()
|
inline |
Returns a scanner over the list of ElementPairs
.
Definition at line 68 of file elementPairs.hh.
Member Data Documentation
◆ elmPairs_
|
private |
List of ElementPairs
.
Definition at line 72 of file elementPairs.hh.
◆ remove_
|
private |
Definition at line 74 of file elementPairs.hh.
The documentation for this class was generated from the following file:
- space/elementPairs.hh