cee::ug::SetPropertyHandler Class Reference

Property handler for set properties. More...

Public Types

enum  PropertyKey { SET_MODE, SET_IDS }
 List of property keys for SetPropertyHandler. More...
 

Public Member Functions

 SetPropertyHandler (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)
 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 elements set property set. More...
 

Detailed Description

Property handler for set properties.

Member Enumeration Documentation

List of property keys for SetPropertyHandler.

Enumerator
SET_MODE 

Set mode.

SET_IDS 

Array of set ids.

Constructor & Destructor Documentation

cee::ug::SetPropertyHandler::SetPropertyHandler ( PropertySet propSet)

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

Member Function Documentation

void cee::ug::SetPropertyHandler::applyToModelSpec ( ModelSpec modelSpec)

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

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

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

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

Returns true if the specified property set is a valid elements set property set.

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

Returns the class type of the property set.

cee::Variant cee::ug::SetPropertyHandler::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::SetPropertyHandler::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.