CEPS  24.01
Cardiac ElectroPhysiology Simulator
BoundarySelector< _Iterator > Class Template Reference

Detailed Description

template<class _Iterator>
class BoundarySelector< _Iterator >

Definition at line 34 of file BoundarySelector.hpp.

#include <BoundarySelector.hpp>

Inheritance diagram for BoundarySelector< _Iterator >:
[legend]

Public Types

using Object = typename AbstractSelector< _Iterator >::Object
 Type of object which is selected. More...
 
using Selector = typename AbstractSelector< _Iterator >::Selector
 Selection function. More...
 
- Public Types inherited from AbstractSelector< _Iterator >
using Object = typename std::iterator_traits< _Iterator >::value_type
 Type of object which is selected. More...
 
using Selector = std::function< CepsBool(Object)>
 Selection function. More...
 

Public Member Functions

 BoundarySelector ()
 Default constructor. More...
 
 BoundarySelector (const BoundarySelector &that)=default
 Copy constructor. More...
 
BoundarySelectoroperator= (const BoundarySelector &that)=default
 Assignment operator. More...
 
void selectBetween (_Iterator first, _Iterator last) override
 Used stored selector to parse items from first to last. More...
 
void onlyOnBoundary (CepsBool)=delete
 Always true. More...
 
- Public Member Functions inherited from AbstractSelector< _Iterator >
AbstractSelectoroperator= (const AbstractSelector &that)
 Assignment operator. More...
 
virtual ~AbstractSelector ()=default
 Virtual destructor needed for polymorphism. More...
 
void onlyOnBoundary (CepsBool value=true)
 Choose only objects that are on boundary. More...
 
void onlyOnThisProc (CepsBool value=true)
 Choose only object that belongs to this proc. More...
 
void appendSelectedTo (CepsVector< Object > *selected)
 Puts selected object at the end of given vector. More...
 
CepsVector< ObjectgetSelected () const
 Get selected, read only. More...
 
virtual void clearSelection ()
 Clears selection. More...
 
virtual void reset ()
 Clears selection, set proc and bdry options to false. More...
 

Additional Inherited Members

- Protected Member Functions inherited from AbstractSelector< _Iterator >
 AbstractSelector ()
 Default constructor. More...
 
 AbstractSelector (const AbstractSelector &that)=default
 Copy constructor. More...
 
void internalRun (Selector *selector, _Iterator first, _Iterator last)
 Adds to the given selector the boundary and proc criteria. More...
 
void internalRun2 (Selector *selector, _Iterator first, _Iterator last)
 Performs the selection. More...
 
- Protected Attributes inherited from AbstractSelector< _Iterator >
CepsBool m_keepOnBoundary
 On top of selector, keep only objects on boundary. More...
 
CepsBool m_keepOnThisProc
 On top of selector, keep only objects owned by this proc. More...
 
CepsVector< Objectm_selected
 The result of selection. More...
 

Member Typedef Documentation

◆ Object

template<class _Iterator >
using BoundarySelector< _Iterator >::Object = typename AbstractSelector<_Iterator>::Object

Type of object which is selected.

Definition at line 39 of file BoundarySelector.hpp.

◆ Selector

template<class _Iterator >
using BoundarySelector< _Iterator >::Selector = typename AbstractSelector<_Iterator>::Selector

Selection function.

Definition at line 41 of file BoundarySelector.hpp.

Constructor & Destructor Documentation

◆ BoundarySelector() [1/2]

template<class _Iterator >
BoundarySelector< _Iterator >::BoundarySelector ( )

Default constructor.

◆ BoundarySelector() [2/2]

template<class _Iterator >
BoundarySelector< _Iterator >::BoundarySelector ( const BoundarySelector< _Iterator > &  that)
default

Copy constructor.

Member Function Documentation

◆ onlyOnBoundary()

template<class _Iterator >
void BoundarySelector< _Iterator >::onlyOnBoundary ( CepsBool  )
delete

Always true.

◆ operator=()

template<class _Iterator >
BoundarySelector& BoundarySelector< _Iterator >::operator= ( const BoundarySelector< _Iterator > &  that)
default

Assignment operator.

◆ selectBetween()

template<class _Iterator >
void BoundarySelector< _Iterator >::selectBetween ( _Iterator  first,
_Iterator  last 
)
overridevirtual

Used stored selector to parse items from first to last.

Implements AbstractSelector< _Iterator >.


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