axom::klee::internal::GeometryOperatorData Class Reference

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

Public Member Functions
	GeometryOperatorData ()=default
	GeometryOperatorData (const Path &path)
	GeometryOperatorData (const Path &path, std::vector< SingleOperatorData > &&singleOperatorData)
std::shared_ptr< GeometryOperator >	makeOperator (const TransformableGeometryProperties &startProperties, const NamedOperatorMap &namedOperators) const
const Path &	getPath () const

Static Public Member Functions
static inlet::Container &	defineSchema (inlet::Container &parent, const std::string &fieldName, const std::string &description)

Detailed Description

The data for the "operator" component of "geometry" objects.

Constructor & Destructor Documentation

GeometryOperatorData() [1/3]

axom::klee::internal::GeometryOperatorData::GeometryOperatorData ( )

default

Construct a GeometryOperatorData with no operators.

GeometryOperatorData() [2/3]

axom::klee::internal::GeometryOperatorData::GeometryOperatorData ( const Path &  path )

explicit

Construct a GeometryOperatorData with no operators.

Parameters

path	the path where the operators were defined

GeometryOperatorData() [3/3]

axom::klee::internal::GeometryOperatorData::GeometryOperatorData ( const Path &  path, std::vector< SingleOperatorData > &&  singleOperatorData  )

explicit

Construct a GeometryOperatorData for the given list of operators

Parameters

path	the path where the operators were defined
singleOperatorData	the data for the individual operators

Member Function Documentation

defineSchema()

static inlet::Container& axom::klee::internal::GeometryOperatorData::defineSchema ( inlet::Container &  parent, const std::string &  fieldName, const std::string &  description  )

static

Define the schema for geometry operators

Parameters

parent	the parent container
fieldName	the name of the field
description	a description of the field

Returns

the Container for the new item

makeOperator()

std::shared_ptr<GeometryOperator> axom::klee::internal::GeometryOperatorData::makeOperator	(	const TransformableGeometryProperties &	startProperties,
		const NamedOperatorMap &	namedOperators
	)		const

Make an operator describing the transformation to apply to the geomtry. May be null.

Parameters

startProperties	properties of the geometry before the first operator
namedOperators	a map of any named operators

Returns

the (possibly null) operator

getPath()

const Path& axom::klee::internal::GeometryOperatorData::getPath ( ) const

inline

Get the path of this operator in the source document

Returns

the operator's path

---

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

• /home/docs/checkouts/readthedocs.org/user_builds/axom/checkouts/latest/src/axom/klee/GeometryOperatorsIO.hpp