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

Detailed Description

template<class _Iterator>
class AttributesSelector< _Iterator >

Definition at line 34 of file AttributesSelector.hpp.

#include <AttributesSelector.hpp>

Inheritance diagram for AttributesSelector< _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

 AttributesSelector ()=default
 Default constructor. More...
 
 AttributesSelector (const AttributesSelector &that)=default
 Copy constructor. More...
 
AttributesSelectoroperator= (const AttributesSelector &that)=default
 Assignment operator. More...
 
void selectBetween (_Iterator first, _Iterator last) override
 Do the selection on elements between given iterators. More...
 
void reset () override
 Clears selected content and attributes. 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...
 
- Public Member Functions inherited from ceps::HoldsAttributes
 HoldsAttributes (const CepsSet< CepsAttribute > &attributes)
 Constructor with any number of attributes. More...
 
 HoldsAttributes (const CepsVector< CepsAttribute > &attributes)
 Constructor with any number of attributes. More...
 
 HoldsAttributes (CepsAttribute *attributes, const CepsUInt &n)
 Constructor with any number of attributes. More...
 
 HoldsAttributes ()=default
 Default constructor. More...
 
 HoldsAttributes (const HoldsAttributes &)=default
 Assignement operator. More...
 
 HoldsAttributes (HoldsAttributes &&) noexcept=default
 Copy constructor. More...
 
virtual ~HoldsAttributes ()=default
 Destructor. More...
 
HoldsAttributesoperator= (const HoldsAttributes &)=default
 Assignment operator. More...
 
HoldsAttributesoperator= (HoldsAttributes &&) noexcept=default
 Assignment operator. More...
 
CepsUInt getNumberOfAttributes () const
 Returns number of attributes of the entity. More...
 
CepsSet< CepsAttribute > & getAttributes ()
 Returns the attributes of the entity. More...
 
const CepsSet< CepsAttribute > & getAttributes () const
 Returns the attributes of the entity, const version. More...
 
void setAttributes (const CepsVector< CepsAttribute > &attributes)
 Sets the attributes of the entity. More...
 
void setAttributes (const CepsSet< CepsAttribute > &attributes)
 Sets the attributes of the entity. More...
 
void setAttributes (const CepsAttribute *attributes, const CepsUInt &n)
 Sets the attributes of the entity. More...
 
template<class _It >
void setAttributes (_It first, _It last)
 Sets the attributes of the entity. More...
 
void addAttribute (const CepsAttribute &name)
 Adds an attribute to the entity. More...
 
void addAttributes (const CepsVector< CepsAttribute > &attributes)
 Adds several attributes to the entity. More...
 
void addAttributes (const CepsSet< CepsAttribute > &attributes)
 Adds several attributes to the entity. More...
 
void addAttributes (const CepsAttribute *attributes, const CepsUInt &n)
 Adds several attributes to the entity. More...
 
template<class _It >
void addAttributes (_It first, _It last)
 Adds several attributes to the entity. More...
 
void removeAttribute (const CepsAttribute &name)
 Removes an attribute from the entity. More...
 
void removeAttributes (const CepsSet< CepsAttribute > &attributes)
 Removes several attributes from the entity. More...
 
void removeAttributes (const CepsVector< CepsAttribute > &attributes)
 Removes several attributes from the entity. More...
 
void removeAttributes (const CepsAttribute *attributes, const CepsUInt &n)
 Removes several attributes from the entity. More...
 
template<class _It >
void removeAttributes (_It first, _It last)
 Removes several attributes from the entity. More...
 
void clearAttributes ()
 Removes all attributes from the entity. More...
 
CepsBool hasAttribute (const CepsAttribute &name) const
 Tells if the entity has the attribute in argument. More...
 
CepsBool hasAllAttributes (const CepsVector< CepsAttribute > &attributes) const
 Tells if the entity has all the attributes in argument. More...
 
CepsBool hasAllAttributes (const CepsAttribute *attributes, const CepsUInt &n) const
 Tells if the entity has all the attributes in argument. More...
 
template<class _It >
CepsBool hasAllAttributes (_It first, _It last) const
 Tells if the entity has all the attributes in argument. More...
 
CepsBool hasOneOfAttributes (const CepsSet< CepsAttribute > &attributes) const
 Tells if the entity has one of the attributes in argument. More...
 
CepsBool hasOneOfAttributes (const CepsVector< CepsAttribute > &attributes) const
 Tells if the entity has one of the attributes in argument. More...
 
CepsBool hasOneOfAttributes (const CepsAttribute *attributes, const CepsUInt &n) const
 Tells if the entity has one of the attributes in argument. More...
 
template<class _It >
CepsBool hasOneOfAttributes (_It first, _It last) const
 Tells if the entity has one of the attributes in argument. More...
 
CepsBool hasUniversalAttribute () const
 Detect if the current entity has the attribute universal. More...
 
void reset ()
 Equivalent to HoldsAttributes::clear() 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...
 
- Protected Attributes inherited from ceps::HoldsAttributes
CepsSet< CepsAttributem_attributes
 The attributes held by the entity. More...
 

Member Typedef Documentation

◆ Object

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

Type of object which is selected.

Definition at line 39 of file AttributesSelector.hpp.

◆ Selector

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

Selection function.

Definition at line 41 of file AttributesSelector.hpp.

Constructor & Destructor Documentation

◆ AttributesSelector() [1/2]

template<class _Iterator >
AttributesSelector< _Iterator >::AttributesSelector ( )
default

Default constructor.

◆ AttributesSelector() [2/2]

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

Copy constructor.

Member Function Documentation

◆ operator=()

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

Assignment operator.

◆ reset()

template<class _Iterator >
void AttributesSelector< _Iterator >::reset ( )
overridevirtual

Clears selected content and attributes.

Reimplemented from AbstractSelector< _Iterator >.

◆ selectBetween()

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

Do the selection on elements between given iterators.

Implements AbstractSelector< _Iterator >.


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