Pointwise Plugin SDK
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Functions
GRDP Variable Manager Tools
+ Collaboration diagram for GRDP Variable Manager Tools:

Functions

PWP_BOOL grdpAssignInfoValue (const char name[], const char value[], const bool create=true)
 Creates a key/string-value pair that defines a GRDP info attribute. More...
 
PWP_BOOL grdpAssignInfoValueBool (const char name[], const bool value, const bool create=true)
 Creates a key/bool-value pair that defines a GRDP info attribute. More...
 
PWP_BOOL grdpAssignInfoValueEnum (const char name[], const char value[], bool create=true)
 Creates a key/enum-value pair that defines a GRDP info attribute. More...
 
PWP_BOOL grdpAssignInfoValueInt (const char name[], const PWP_INT value, const bool create=true)
 Creates a key/PWP_INT-value pair that defines a GRDP info attribute. More...
 
PWP_BOOL grdpAssignInfoValueReal (const char name[], const PWP_REAL value, const bool create=true)
 Creates a key/PWP_REAL-value pair that defines a GRDP info attribute. More...
 
PWP_BOOL grdpAssignInfoValueUInt (const char name[], const PWP_UINT value, const bool create=true)
 Creates a key/PWP_UINT-value pair that defines a GRDP info attribute. More...
 
PWP_BOOL grdpPublishValueDefinition (const char name[], PWP_ENUM_VALTYPE type, const char value[], const char access[], const char desc[], const char range[])
 Creates a collection of key/value pairs that represent a published grid import attribute definition. More...
 

Detailed Description

Implements the variable manager subsystem.

These are GRDP wrappers for the PwuValueXxxx() functions.

Function Documentation

PWP_BOOL grdpAssignInfoValue ( const char  name[],
const char  value[],
const bool  create = true 
)

Creates a key/string-value pair that defines a GRDP info attribute.

Parameters
nameThe value name.
valueThe value.
createIf true, the key/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the GRDP_INFO_GROUP group.
See Also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_INFO_GROUP

Definition at line 218 of file apiGRDPUtils.cxx.

References GRDP_INFO_GROUP, and PwuAssignValue().

PWP_BOOL grdpAssignInfoValueBool ( const char  name[],
const bool  value,
const bool  create = true 
)

Creates a key/bool-value pair that defines a GRDP info attribute.

Parameters
nameThe value name.
valueThe value.
createIf true, the key/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the GRDP_INFO_GROUP group.
See Also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_INFO_GROUP

Definition at line 246 of file apiGRDPUtils.cxx.

References GRDP_INFO_GROUP, and PwuAssignValueUInt().

PWP_BOOL grdpAssignInfoValueEnum ( const char  name[],
const char  value[],
bool  create = true 
)

Creates a key/enum-value pair that defines a GRDP info attribute.

Parameters
nameThe value name.
valueThe vbar delimted, enum value.
createIf true, the key/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the GRDP_INFO_GROUP group.
See Also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_INFO_GROUP

Definition at line 253 of file apiGRDPUtils.cxx.

References GRDP_INFO_GROUP, and PwuAssignValueEnum().

PWP_BOOL grdpAssignInfoValueInt ( const char  name[],
const PWP_INT  value,
const bool  create = true 
)

Creates a key/PWP_INT-value pair that defines a GRDP info attribute.

Parameters
nameThe value name.
valueThe value.
createIf true, the key/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the GRDP_INFO_GROUP group.
See Also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_INFO_GROUP

Definition at line 225 of file apiGRDPUtils.cxx.

References GRDP_INFO_GROUP, and PwuAssignValueInt().

PWP_BOOL grdpAssignInfoValueReal ( const char  name[],
const PWP_REAL  value,
const bool  create = true 
)

Creates a key/PWP_REAL-value pair that defines a GRDP info attribute.

Parameters
nameThe value name.
valueThe value.
createIf true, the key/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the GRDP_INFO_GROUP group.
See Also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_INFO_GROUP

Definition at line 239 of file apiGRDPUtils.cxx.

References GRDP_INFO_GROUP, and PwuAssignValueReal().

PWP_BOOL grdpAssignInfoValueUInt ( const char  name[],
const PWP_UINT  value,
const bool  create = true 
)

Creates a key/PWP_UINT-value pair that defines a GRDP info attribute.

Parameters
nameThe value name.
valueThe value.
createIf true, the key/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
Creates a key/value pair in the GRDP_INFO_GROUP group.
See Also
PwuAssignValueString(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_INFO_GROUP

Definition at line 232 of file apiGRDPUtils.cxx.

References GRDP_INFO_GROUP, and PwuAssignValueUInt().

PWP_BOOL grdpPublishValueDefinition ( const char  name[],
PWP_ENUM_VALTYPE  type,
const char  value[],
const char  access[],
const char  desc[],
const char  range[] 
)

Creates a collection of key/value pairs that represent a published grid import attribute definition.

Parameters
nameThe value name.
typeThe value data type.
valueThe value as a type-appropriate string.
accessThe value access flags.
descThe value description.
rangeThe value range as a type-appropriate string.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
The key/value pairs are created in the GRDP_VALUE_GROUP group.
These value definitions are discoverable in glyph using the pw::Application actions getGRDPSolverAttributeNames, get/setGRDPSolverAttributeDefinition, setGRDPSolverAttributeDefinition, and getGRDPSolverAttribute.
These values can be edited by the user in Pointwise using the "GRDP/Set Solver Attributes..." menu.
See Also
PwuPublishValueDefinition(), PwpGetValue(), PWP_ENUM_VALTYPE, GRDP_VALUE_GROUP

Definition at line 207 of file apiGRDPUtils.cxx.

References GRDP_VALUE_GROUP, PWP_FALSE, and PwuPublishValueDefinition().