Public Member Functions
Sundance::CellPredicate Class Reference

User-level handle for predicates (deriving from CellPredicateBase) used to decide whether a given cell passes a CellFilter. More...

Inheritance diagram for Sundance::CellPredicate:
Sundance::Handle< CellPredicateBase > Sundance::ObjectWithVerbosityBase

List of all members.

Public Member Functions

 CellPredicate ()
 Empty ctor.
 CellPredicate (Handleable< CellPredicateBase > *rawPtr)
 Construct a CellPredicate with a raw pointer to a CellPredicateBase.
 CellPredicate (const RefCountPtr< CellPredicateBase > &smartPtr)
 Construct a CellPredicate with a smart pointer to a CellPredicateBase.
 CellPredicate (const RCP< CellPredicateFunctorBase > &func)
 construct from a positional cell predicate functor
 CellPredicate (Sundance::Handleable< CellPredicateFunctorBase > *func)
 construct from a positional cell predicate functor
 CellPredicate (ParametrizedCurve &curve, CurveCellFilterMode filterMode)
 construct from a positional cell predicate functor
XMLObject toXML () const
 write to XML
std::string description () const
 Return a short descriptive std::string using the Describable interface.
void setMesh (const Mesh &mesh, int cellDim) const
 set the mesh on which cells are to be tested
bool operator< (const CellPredicate &other) const
 compare to another predicate, used for placement in STL containers

Detailed Description

User-level handle for predicates (deriving from CellPredicateBase) used to decide whether a given cell passes a CellFilter.

Definition at line 54 of file SundanceCellPredicate.hpp.


Constructor & Destructor Documentation

Sundance::CellPredicate::CellPredicate ( ) [inline]

Empty ctor.

Definition at line 59 of file SundanceCellPredicate.hpp.

Sundance::CellPredicate::CellPredicate ( Handleable< CellPredicateBase > *  rawPtr) [inline]

Construct a CellPredicate with a raw pointer to a CellPredicateBase.

Definition at line 59 of file SundanceCellPredicate.hpp.

Sundance::CellPredicate::CellPredicate ( const RefCountPtr< CellPredicateBase > &  smartPtr) [inline]

Construct a CellPredicate with a smart pointer to a CellPredicateBase.

Definition at line 59 of file SundanceCellPredicate.hpp.

CellPredicate::CellPredicate ( const RCP< CellPredicateFunctorBase > &  func)

construct from a positional cell predicate functor

Definition at line 40 of file SundanceCellPredicate.cpp.

CellPredicate::CellPredicate ( Sundance::Handleable< CellPredicateFunctorBase > *  func)

construct from a positional cell predicate functor

Definition at line 44 of file SundanceCellPredicate.cpp.

CellPredicate::CellPredicate ( ParametrizedCurve &  curve,
CurveCellFilterMode  filterMode 
)

construct from a positional cell predicate functor

Definition at line 48 of file SundanceCellPredicate.cpp.


Member Function Documentation

std::string Sundance::CellPredicate::description ( ) const [inline]

Return a short descriptive std::string using the Describable interface.

If the contents of the handle cannot be downcasted or crosscasted to a Describable*, an exception will be thrown.

Reimplemented from Sundance::Handle< CellPredicateBase >.

Definition at line 74 of file SundanceCellPredicate.hpp.

References Sundance::Handle< CellPredicateBase >::ptr().

Referenced by Sundance::SubsetCellFilter::description(), and Sundance::SubsetCellFilter::SubsetCellFilter().

bool CellPredicate::operator< ( const CellPredicate other) const

compare to another predicate, used for placement in STL containers

Definition at line 53 of file SundanceCellPredicate.cpp.

References Sundance::Handle< PointerType >::ptr(), and Sundance::Handle< CellPredicateBase >::ptr().

void Sundance::CellPredicate::setMesh ( const Mesh mesh,
int  cellDim 
) const [inline]

set the mesh on which cells are to be tested

Definition at line 79 of file SundanceCellPredicate.hpp.

References Sundance::Handle< CellPredicateBase >::ptr().

Referenced by Sundance::SubsetCellFilter::internalGetCells().

XMLObject Sundance::CellPredicate::toXML ( ) const [inline]

Site Contact