ElementCriterionAllPass Class Reference

Element criterion that will pass for all elements. More...

#include <Mesh/Geometry/elementcriterionallpass.h>

Inheritance diagram for ElementCriterionAllPass:

Public Member Functions
ElementCriterionAllPass *	clone () const override
void	destroy () override
bool	pass (const Element &element) const override
Public Member Functions inherited from ElementCriterion
	~ElementCriterion () override=default
ElementCriterion *	clone () const override=0
virtual void	destroy ()=0
virtual bool	pass (const Element &element) const =0
virtual void	postVisits ()
virtual bool	preVisits (MeshModel &model)
Public Member Functions inherited from Clonable
virtual	~Clonable ()=default
virtual Clonable *	clone () const =0
Public Member Functions inherited from Observable
virtual	~Observable ()
void	attachObserver (Observer &observer)
void	destroy ()
void	detachObserver (Observer &observer)
void	notifyEvent (const ObservableEvent &event)

Additional Inherited Members
Protected Member Functions inherited from Observable
	Observable ()
	Observable (const Observable &)

Detailed Description

This class has little purpose on its own other than as a sensible default criterion in some situations.

Member Function Documentation

clone()

ElementCriterionAllPass * clone ( ) const

overridevirtual

Returns

A clone of this object.

Note

Subclasses would normally return their own type rather than the Clonable type. The C++ language rules allow a more derived type to be returned from a virtual function and the compiler will still treat it as a valid override.

We redeclare this function only so that the more derived return type is available without casting.

Implements ElementCriterion.

destroy()

void destroy ( )

overridevirtual

Destroys the object. This function is usually implemented by calling operator delete on the object.

See also

clone()

Implements ElementCriterion.

pass()

bool pass ( const Element &  element ) const

overridevirtual

Parameters

element

The element for which the criterion is to be tested.

Precondition

Clients must have called preVisits() at some point before they are allowed to call pass(). The last call to preVisits() must have returned true.

The usual sequence for a client is to first call preVisits() and check that the return value is true. Then, they call pass() for all the elements in a model or for some subset of elements that interests them (eg just one type of element). The client must call postVisits() when they will no longer be calling pass() anymore. The model that was passed to preVisits() must remain valid until postVisits() returns.

Returns

True if element passes the criterion determined by the subclass.

For the ElementCriterionAllPass class, this function always returns true regardless of the element passed to it.

Implements ElementCriterion.