cee::ug::ResultSelectionPropertyHandler Class Reference

Property handler for result section properties. More...

Public Types

enum  PropertyKey {
  FRINGES_RESULT_ID, CONTOUR_LINES_RESULT_ID, VECTOR_RESULT_IDS, DISPLACEMENT_RESULT_ID,
  TRANSFORMATION_RESULT, VISIBILITY_RESULT, PER_PART_FRINGES_RESULT_IDS
}
 List of property keys for ResultSelectionPropertyHandler. More...
 

Public Member Functions

 ResultSelectionPropertyHandler (PropertySet *propSet)
 Creates a result section property handler from a given property set propSet. More...
 
Variant propertyValue (PropertyKey key) const
 Returns the property value for the specified property key. More...
 
void setPropertyValue (PropertyKey key, Variant data)
 Sets the property key and value to this handlers property set. More...
 
void applyToModelSpec (ModelSpec *modelSpec) const
 Applies the properties in this property set to the specified model specification. More...
 
void buildProperties (const ModelSpec &modelSpec)
 Sets the property keys and values for this property set from the model specification modelSpec. More...
 

Static Public Member Functions

static Str propertySetClassType ()
 Returns the class type of the property set. More...
 
static bool isValidPropertySet (const PropertySet &propSet)
 Returns true if the specified property set is a valid result section property set. More...
 

Detailed Description

Property handler for result section properties.

Member Enumeration Documentation

List of property keys for ResultSelectionPropertyHandler.

Enumerator
FRINGES_RESULT_ID 

Scalar fringes result id.

CONTOUR_LINES_RESULT_ID 

Scalar contour lines result id.

VECTOR_RESULT_IDS 

Vector result id.

DISPLACEMENT_RESULT_ID 

Displacement result id.

TRANSFORMATION_RESULT 

Transformation result on/off.

VISIBILITY_RESULT 

Visibility result on/off.

PER_PART_FRINGES_RESULT_IDS 

Per part override of which scalar result to show as fringes.

Constructor & Destructor Documentation

cee::ug::ResultSelectionPropertyHandler::ResultSelectionPropertyHandler ( PropertySet propSet)

Creates a result section property handler from a given property set propSet.

Member Function Documentation

void cee::ug::ResultSelectionPropertyHandler::applyToModelSpec ( ModelSpec modelSpec) const

Applies the properties in this property set to the specified model specification.

void cee::ug::ResultSelectionPropertyHandler::buildProperties ( const ModelSpec modelSpec)

Sets the property keys and values for this property set from the model specification modelSpec.

bool cee::ug::ResultSelectionPropertyHandler::isValidPropertySet ( const PropertySet propSet)
static

Returns true if the specified property set is a valid result section property set.

Str cee::ug::ResultSelectionPropertyHandler::propertySetClassType ( )
static

Returns the class type of the property set.

cee::Variant cee::ug::ResultSelectionPropertyHandler::propertyValue ( PropertyKey  key) const

Returns the property value for the specified property key.

Returns an empty Variant if the property key was not found.

void cee::ug::ResultSelectionPropertyHandler::setPropertyValue ( PropertyKey  key,
Variant  data 
)

Sets the property key and value to this handlers property set.

If key exists in the property set, the paired property value is updated to data. Otherwise the key/value pair is added to the property set.