NodeCriterionInRegion Class Reference

Node criterion that will pass for all nodes in a provided Region. More...

#include <Mesh/Geometry/nodecriterioninregion.h>

Inheritance diagram for NodeCriterionInRegion:

Public Member Functions
	NodeCriterionInRegion ()
	NodeCriterionInRegion (const NodeCriterionInRegion &criterion)
	NodeCriterionInRegion (const Region &region)
	~NodeCriterionInRegion () override
NodeCriterionInRegion *	clone () const override
void	destroy () override
NodeCriterionInRegion &	operator= (const NodeCriterionInRegion &criterion)
bool	pass (const Node &node) const override
void	setRegion (const Region &region)
Public Member Functions inherited from NodeCriterion
	~NodeCriterion () override=default
NodeCriterion *	clone () const override=0
virtual void	destroy ()=0
virtual bool	pass (const Node &node) const =0
virtual void	postVisits ()
virtual bool	preVisits (MeshModel &model)
Public Member Functions inherited from Clonable
virtual	~Clonable ()=default
virtual Clonable *	clone () const =0

Detailed Description

Set the region for the criterion either in the constructor or by using the setRegion() function.

Constructor & Destructor Documentation

NodeCriterionInRegion() [1/3]

NodeCriterionInRegion

(

)

NodeCriterionInRegion() [2/3]

NodeCriterionInRegion

(

const NodeCriterionInRegion &

criterion

)

NodeCriterionInRegion() [3/3]

NodeCriterionInRegion

(

const Region &

region

)

~NodeCriterionInRegion()

~NodeCriterionInRegion ( )

override

Member Function Documentation

clone()

NodeCriterionInRegion * 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 NodeCriterion.

destroy()

void destroy ( )

overridevirtual

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

See also

clone()

Implements NodeCriterion.

operator=()

NodeCriterionInRegion & operator=

(

const NodeCriterionInRegion &

criterion

)

pass()

bool pass ( const Node &  node ) const

overridevirtual

Parameters

node	The node to be tested against the currently set region.

Returns

True if node is within the currently set region. If the region is null, this will always be false.

Implements NodeCriterion.

setRegion()

void setRegion

(

const Region &

region

)

Parameters

region

The new region to match nodes against.