AXOM
Axom provides a robust, flexible software infrastructure for the development of multi-physics applications and computational tools.
axom::klee::CompositeOperator Class Reference

#include </home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/klee/GeometryOperators.hpp>

Inheritance diagram for axom::klee::CompositeOperator:

Public Types

using OpPtr = std::shared_ptr< const GeometryOperator >
 

Public Member Functions

void accept (GeometryOperatorVisitor &visitor) const override
 
void addOperator (const OpPtr &op)
 
const std::vector< OpPtr > & getOperators () const
 
TransformableGeometryProperties getEndProperties () const override
 
 GeometryOperator (const TransformableGeometryProperties &startProperties)
 
const TransformableGeometryPropertiesgetStartProperties () const
 

Detailed Description

A CompositeOperator is a GeometryOperator which consists of a list of other operators.

Member Typedef Documentation

◆ OpPtr

Member Function Documentation

◆ accept()

void axom::klee::CompositeOperator::accept ( GeometryOperatorVisitor visitor) const
overridevirtual

Accept the given visitor. The appropriate visit() method will be called on the visitor based on the run-time type of this operator.

Parameters
visitorthe visitor to accept.

Implements axom::klee::GeometryOperator.

◆ addOperator()

void axom::klee::CompositeOperator::addOperator ( const OpPtr op)

Add the given operator to the end of the list of operators in this composite.

Parameters
opthe operator to add

◆ getOperators()

const std::vector<OpPtr>& axom::klee::CompositeOperator::getOperators ( ) const
inline

Get a list of all the operators. They should be applied in order.

Returns
the list of operators

◆ getEndProperties()

TransformableGeometryProperties axom::klee::CompositeOperator::getEndProperties ( ) const
overridevirtual

Get the properties after this operator is applied

Returns
the properties which are true after this operator is applied

Reimplemented from axom::klee::GeometryOperator.

◆ GeometryOperator()

axom::klee::GeometryOperator::GeometryOperator
explicit

Create an operator with the given start properties

Parameters
startPropertiesthe properties before the operator is applied

◆ getStartProperties()

const TransformableGeometryProperties& axom::klee::GeometryOperator::getStartProperties ( ) const
inlineinherited

Get the properties that the operator expects to start in

Returns
the properties which must be true before this operator is applied

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