axom::klee::UnitConverter Class Reference

An operator for converting units. More...

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

Inheritance diagram for axom::klee::UnitConverter:

Public Member Functions
	UnitConverter (LengthUnit endUnits, const TransformableGeometryProperties &startProperties)
TransformableGeometryProperties	getEndProperties () const override
numerics::Matrix< double >	toMatrix () const override
void	accept (GeometryOperatorVisitor &visitor) const override
double	getConversionFactor () const
	GeometryOperator (const TransformableGeometryProperties &startProperties)
const TransformableGeometryProperties &	getStartProperties () const

Detailed Description

An operator for converting units.

Constructor & Destructor Documentation

UnitConverter()

axom::klee::UnitConverter::UnitConverter	(	LengthUnit	endUnits,
		const TransformableGeometryProperties &	startProperties
	)

Convert from the units specified in the start properties to the given end units

Parameters

endUnits	the units at the end of the operation
startProperties	the properties before the operation

Member Function Documentation

getEndProperties()

TransformableGeometryProperties axom::klee::UnitConverter::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.

toMatrix()

numerics::Matrix<double> axom::klee::UnitConverter::toMatrix ( ) const

overridevirtual

Convert this operator to its matrix representation.

Returns

a 4x4 affine transformation matrix

Implements axom::klee::MatrixOperator.

accept()

void axom::klee::UnitConverter::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

visitor

the visitor to accept.

Implements axom::klee::GeometryOperator.

getConversionFactor()

double axom::klee::UnitConverter::getConversionFactor

(

)

const

Get the conversion factor used to convert from the start units to the end units

Returns

the unit conversion factor

GeometryOperator()

axom::klee::GeometryOperator::GeometryOperator

explicitinherited

Create an operator with the given start properties

Parameters

startProperties

the 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:

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/develop/src/axom/klee/GeometryOperators.hpp