cee::ug::OverlayPlotCurvePropertyHandler Class Reference

Property handler for overlay plot curve properties. More...

Public Types

enum  PropertyKey {
  CONTEXT_OVERLAY_PLOT_ID, VTFX_PLOT_DATA_INDEX, VTFX_PLOT_VARIABLE_INDEX_X, VTFX_PLOT_VARIABLE_INDEX_Y,
  TITLE, COLOR
}
 List of property keys for OverlayPlotCurvePropertyHandler. More...
 

Public Member Functions

 OverlayPlotCurvePropertyHandler (PropertySet *propSet)
 Creates an overlay plot curve 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...
 

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 overlay plot property set. More...
 

Detailed Description

Property handler for overlay plot curve properties.

Member Enumeration Documentation

List of property keys for OverlayPlotCurvePropertyHandler.

Enumerator
CONTEXT_OVERLAY_PLOT_ID 

Unique id for identifying a plot.

VTFX_PLOT_DATA_INDEX 

Index of VTFx data block containing the plot data.

VTFX_PLOT_VARIABLE_INDEX_X 

Index of variable in VTFx data block containing curve values for x axis.

VTFX_PLOT_VARIABLE_INDEX_Y 

Index of variable in VTFx data block containing curve values for y axis.

TITLE 

Curve title

COLOR 

Curve color

Constructor & Destructor Documentation

cee::ug::OverlayPlotCurvePropertyHandler::OverlayPlotCurvePropertyHandler ( PropertySet propSet)

Creates an overlay plot curve property handler from a given property set propSet.

Member Function Documentation

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

Returns true if the specified property set is a valid overlay plot property set.

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

Returns the class type of the property set.

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