CustomSelector< _Iterator > Class Template Reference

Detailed Description

template<class _Iterator>
class CustomSelector< _Iterator >

Definition at line 34 of file CustomSelector.hpp.

#include <CustomSelector.hpp>

Inheritance diagram for CustomSelector< _Iterator >:

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
	CustomSelector ()=delete
	No default constructor. More...
	CustomSelector (Selector *selector)
	Constructor must be provided a valid ptr to function. More...
	CustomSelector (const CustomSelector &that)=default
	Copy constructor. More...
CustomSelector &	operator= (const CustomSelector &that)=default
	Assignment operator. More...
void	selectBetween (_Iterator first, _Iterator last) override
	Used stored selector to parse items from first to last. More...
Public Member Functions inherited from AbstractSelector< _Iterator >
AbstractSelector &	operator= (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< Object >	getSelected () 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...

Protected Attributes
Selector *	m_selector
	The custom selection function, passed at instanciation. 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< Object >	m_selected
	The result of selection. 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...

Member Typedef Documentation

Object

template<class _Iterator >

using CustomSelector< _Iterator >::Object = typename AbstractSelector<_Iterator>::Object

Type of object which is selected.

Definition at line 39 of file CustomSelector.hpp.

Selector

template<class _Iterator >

using CustomSelector< _Iterator >::Selector = typename AbstractSelector<_Iterator>::Selector

Selection function.

Definition at line 41 of file CustomSelector.hpp.

Constructor & Destructor Documentation

CustomSelector() [1/3]

template<class _Iterator >

CustomSelector< _Iterator >::CustomSelector ( )

delete

No default constructor.

CustomSelector() [2/3]

template<class _Iterator >

CustomSelector< _Iterator >::CustomSelector ( Selector *  selector )

explicit

Constructor must be provided a valid ptr to function.

CustomSelector() [3/3]

template<class _Iterator >

CustomSelector< _Iterator >::CustomSelector ( const CustomSelector< _Iterator > &  that )

default

Copy constructor.

Member Function Documentation

operator=()

template<class _Iterator >

CustomSelector& CustomSelector< _Iterator >::operator= ( const CustomSelector< _Iterator > &  that )

default

Assignment operator.

selectBetween()

template<class _Iterator >

void CustomSelector< _Iterator >::selectBetween ( _Iterator  first, _Iterator  last  )

overridevirtual

Used stored selector to parse items from first to last.

Implements AbstractSelector< _Iterator >.

Field Documentation

m_selector

template<class _Iterator >

Selector* CustomSelector< _Iterator >::m_selector

protected

The custom selection function, passed at instanciation.

Definition at line 62 of file CustomSelector.hpp.

---

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

• /builds/xxjFYZX3/0/carmen/ceps/src/geometry/selectors/CustomSelector.hpp