Pointwise Plugin SDK
Functions
+ Collaboration diagram for Variable Manager Tools:

Functions

PWP_BOOL PwuAssignValueEnum (const char group[], const char name[], const char value[], bool createIfNotExists=false)
 
PWP_BOOL PwuAssignValueInt (const char group[], const char name[], PWP_INT value, bool createIfNotExists=false)
 
PWP_BOOL PwuAssignValueReal (const char group[], const char name[], PWP_REAL value, bool createIfNotExists=false)
 
PWP_BOOL PwuAssignValueString (const char group[], const char name[], const char value[], bool createIfNotExists=false)
 Assign or create a value. More...
 
PWP_BOOL PwuAssignValueUInt (const char group[], const char name[], PWP_UINT value, bool createIfNotExists=false)
 
PWP_BOOL PwuGetValue (const char group[], const char name[], PWP_HVALUE value)
 Implementation of the PwpGetValue() API function. More...
 
PWP_BOOL PwuPublishValueDefinition (const char group[], const char name[], PWP_ENUM_VALTYPE type, const char value[], const char access[], const char desc[], const char range[])
 Create a value. More...
 
PWP_BOOL PwuValueSetString (PWP_HVALUE value, const char *val)
 Set the value of a variable handle. More...
 
PWP_BOOL PwuValueSetInt (PWP_HVALUE value, PWP_INT val)
 Set the value of a variable handle. More...
 
PWP_BOOL PwuValueSetUInt (PWP_HVALUE value, PWP_UINT val)
 Set the value of a variable handle. More...
 
PWP_BOOL PwuValueSetReal (PWP_HVALUE value, PWP_REAL val)
 Set the value of a variable handle. More...
 
PWP_BOOL PwuValueSetEnum (PWP_HVALUE value, const char *val)
 Set the value of a variable handle. More...
 

Detailed Description

Implements the variable manager subsystem.

Function Documentation

◆ PwuAssignValueEnum()

PWP_BOOL PwuAssignValueEnum ( const char  group[],
const char  name[],
const char  value[],
bool  createIfNotExists = false 
)

Definition at line 904 of file apiPWPUtils.cxx.

References PwuAssignValue().

Referenced by caeuAssignInfoValue(), and grdpAssignInfoValue().

◆ PwuAssignValueInt()

PWP_BOOL PwuAssignValueInt ( const char  group[],
const char  name[],
PWP_INT  value,
bool  createIfNotExists = false 
)

Definition at line 877 of file apiPWPUtils.cxx.

References PwuAssignValue().

◆ PwuAssignValueReal()

PWP_BOOL PwuAssignValueReal ( const char  group[],
const char  name[],
PWP_REAL  value,
bool  createIfNotExists = false 
)

Definition at line 895 of file apiPWPUtils.cxx.

References PwuAssignValue().

◆ PwuAssignValueString()

PWP_BOOL PwuAssignValueString ( const char  group[],
const char  name[],
const char  value[],
bool  createIfNotExists = false 
)

Assign or create a value.

Parameters
groupThe value's group.
nameThe value's name.
valueThe typed value being assigned.
createIfNotExistsIf true, the name/value pair will be silently created if it does not already exist.
Returns
PWP_TRUE on success. PWP_FALSE on failure.
See also
PwpGetValue(), PWP_ENUM_VALTYPE

◆ PwuAssignValueUInt()

PWP_BOOL PwuAssignValueUInt ( const char  group[],
const char  name[],
PWP_UINT  value,
bool  createIfNotExists = false 
)

Definition at line 886 of file apiPWPUtils.cxx.

References PwuAssignValue().

◆ PwuGetValue()

PWP_BOOL PwuGetValue ( const char  group[],
const char  name[],
PWP_HVALUE  value 
)

Implementation of the PwpGetValue() API function.

Parameters
groupThe target value group.
nameThe target value name.
valueThe value handle pased to GgApiSpecPWP::getValue().
Returns
PWP_TRUE on success. PWP_FALSE on failure.
Note
See PwpGetValue() for full documentation.
See also
PwpGetValue(), PwuValueSetString(), PwuValueSetInt(), PwuValueSetUInt(), PwuValueSetReal(), PwuValueSetEnum()

Definition at line 955 of file apiPWPUtils.cxx.

References NamedStrings::get(), namedStrings, PWP_CAST_BOOL, PwuJoin(), and PwuValueSetString().

Referenced by PwpGetValue().

◆ PwuPublishValueDefinition()

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

Create a value.

Parameters
groupThe value group.
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.
See also
PwpGetValue(), PWP_ENUM_VALTYPE

Definition at line 911 of file apiPWPUtils.cxx.

References NamedStrings::exists(), namedStrings, PWP_FALSE, PWP_TRUE, PwuJoin(), PwuValueDefnAccessKey(), PwuValueDefnDefaultKey(), PwuValueDefnDescKey(), PwuValueDefnNameKey(), PwuValueDefnRangeKey(), PwuValueDefnTypeKey(), PwuValueNamesGroup(), and typeToString().

Referenced by caeuPublishValueDefinition(), and grdpPublishValueDefinition().

◆ PwuValueSetEnum()

PWP_BOOL PwuValueSetEnum ( PWP_HVALUE  value,
const char *  val 
)

Set the value of a variable handle.

Parameters
valueThe value handle pased to GgApiSpecPWP::getValue().
valThe typed value to wtite to value.
Returns
PWP_TRUE on success. PWP_FALSE on failure.

Definition at line 1009 of file apiPWPUtils.cxx.

◆ PwuValueSetInt()

PWP_BOOL PwuValueSetInt ( PWP_HVALUE  value,
PWP_INT  val 
)

Set the value of a variable handle.

Parameters
valueThe value handle pased to GgApiSpecPWP::getValue().
valThe typed value to wtite to value.
Returns
PWP_TRUE on success. PWP_FALSE on failure.

Definition at line 988 of file apiPWPUtils.cxx.

◆ PwuValueSetReal()

PWP_BOOL PwuValueSetReal ( PWP_HVALUE  value,
PWP_REAL  val 
)

Set the value of a variable handle.

Parameters
valueThe value handle pased to GgApiSpecPWP::getValue().
valThe typed value to wtite to value.
Returns
PWP_TRUE on success. PWP_FALSE on failure.

Definition at line 1002 of file apiPWPUtils.cxx.

◆ PwuValueSetString()

PWP_BOOL PwuValueSetString ( PWP_HVALUE  value,
const char *  val 
)

Set the value of a variable handle.

Parameters
valueThe value handle pased to GgApiSpecPWP::getValue().
valThe typed value to wtite to value.
Returns
PWP_TRUE on success. PWP_FALSE on failure.

Definition at line 981 of file apiPWPUtils.cxx.

Referenced by PwuGetValue().

◆ PwuValueSetUInt()

PWP_BOOL PwuValueSetUInt ( PWP_HVALUE  value,
PWP_UINT  val 
)

Set the value of a variable handle.

Parameters
valueThe value handle pased to GgApiSpecPWP::getValue().
valThe typed value to wtite to value.
Returns
PWP_TRUE on success. PWP_FALSE on failure.

Definition at line 995 of file apiPWPUtils.cxx.