HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Public Attributes | List of all members
ElementEquivalenceOptions Class Reference

#include <Element.h>

Public Member Functions

 ElementEquivalenceOptions ()
 
 ~ElementEquivalenceOptions ()
 

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 1359 of file Element.h.

Constructor & Destructor Documentation

ElementEquivalenceOptions::ElementEquivalenceOptions ( )
inline

Definition at line 1362 of file Element.h.

ElementEquivalenceOptions::~ElementEquivalenceOptions ( )
inline

Definition at line 1369 of file Element.h.

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 1390 of file Element.h.

Value::FloatFormat ElementEquivalenceOptions::floatFormat

Floating point format to use for floating point value comparisons.

Definition at line 1376 of file Element.h.

int ElementEquivalenceOptions::floatPrecision

Floating point precision to use for floating point value comparisons.

Definition at line 1379 of file Element.h.

bool ElementEquivalenceOptions::performValueComparisons

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

Definition at line 1373 of file Element.h.

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