ElementEquivalenceOptions Class Reference

#include <Element.h>

Public Member Functions
	ElementEquivalenceOptions ()
	~ElementEquivalenceOptions ()=default

Public Attributes
bool	performValueComparisons
Value::FloatFormat	floatFormat
	Floating point format to use for floating point value comparisons. More...
int	floatPrecision
	Floating point precision to use for floating point value comparisons. More...
StringSet	attributeExclusionList

Detailed Description

A set of options for comparing the functional equivalence of elements.

Definition at line 1358 of file Element.h.

Constructor & Destructor Documentation

ElementEquivalenceOptions::ElementEquivalenceOptions ( )

inline

Definition at line 1361 of file Element.h.

ElementEquivalenceOptions::~ElementEquivalenceOptions ( )

default

Member Data Documentation

StringSet ElementEquivalenceOptions::attributeExclusionList

Specifies the set of attributes that should be excluded when performing a comparison. By default all attributes are considered. Name and category attributes cannot be excluded.

For example, to exclude UI and documentation attributes from consideration the follow may be set: attributeExclusionList = { ValueElement::UI_MIN_ATTRIBUTE, ValueElement::UI_MAX_ATTRIBUTE, ValueElement::UI_SOFT_MIN_ATTRIBUTE, ValueElement::UI_SOFT_MAX_ATTRIBUTE, ValueElement::UI_STEP_ATTRIBUTE, Element::XPOS_ATTRIBUTE, Element::YPOS_ATTRIBUTE, Element::DOC_ATTRIBUTE };

Definition at line 1389 of file Element.h.

Value::FloatFormat ElementEquivalenceOptions::floatFormat

Floating point format to use for floating point value comparisons.

Definition at line 1375 of file Element.h.

int ElementEquivalenceOptions::floatPrecision

Floating point precision to use for floating point value comparisons.

Definition at line 1378 of file Element.h.

bool ElementEquivalenceOptions::performValueComparisons

Perform value comparisons as opposed to literal string comparisons. Default is true.

Definition at line 1372 of file Element.h.

---

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

• MaterialXCore/Element.h