SphereSelector< _Iterator > Class Template Reference

Detailed Description

template<class _Iterator>
class SphereSelector< _Iterator >

Definition at line 34 of file SphereSelector.hpp.

#include <SphereSelector.hpp>

Inheritance diagram for SphereSelector< _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
	SphereSelector ()=delete
	Default constructor, delete, need a diameter and a center. More...
	SphereSelector (CepsReal3D center, CepsReal diameter)
	Constructor with diameter and center. More...
	SphereSelector (const SphereSelector &that)=default
	Copy constructor. More...
SphereSelector &	operator= (const SphereSelector &that)=default
	Assignment operator. More...
void	selectBetween (_Iterator first, _Iterator last) override
	Do the selection on elements between given iterators. 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...

Private Attributes
CepsReal3D	m_center
CepsReal	m_diameter

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< Object >	m_selected
	The result of selection. More...

Member Typedef Documentation

Object

template<class _Iterator >

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

Type of object which is selected.

Definition at line 38 of file SphereSelector.hpp.

Selector

template<class _Iterator >

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

Selection function.

Definition at line 40 of file SphereSelector.hpp.

Constructor & Destructor Documentation

SphereSelector() [1/3]

template<class _Iterator >

SphereSelector< _Iterator >::SphereSelector ( )

delete

Default constructor, delete, need a diameter and a center.

SphereSelector() [2/3]

template<class _Iterator >

SphereSelector< _Iterator >::SphereSelector	(	CepsReal3D	center,
		CepsReal	diameter
	)

Constructor with diameter and center.

SphereSelector() [3/3]

template<class _Iterator >

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

default

Copy constructor.

Member Function Documentation

operator=()

template<class _Iterator >

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

default

Assignment operator.

selectBetween()

template<class _Iterator >

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

overridevirtual

Do the selection on elements between given iterators.

Implements AbstractSelector< _Iterator >.

Field Documentation

m_center

template<class _Iterator >

CepsReal3D SphereSelector< _Iterator >::m_center

private

Definition at line 55 of file SphereSelector.hpp.

m_diameter

template<class _Iterator >

CepsReal SphereSelector< _Iterator >::m_diameter

private

Definition at line 56 of file SphereSelector.hpp.

---

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

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