Base class for spacing types
pw:: | Base class for spacing types |
Static Actions | |
createNamedValue | This action defines a named spacing value. |
getNamedValueNames | This action returns a list of named spacing values. |
getNamedValue | This action returns value of a named spacing value. |
changeNamedValue | This action changes the value of a named spacing value. |
renameNamedValue | This action renames a named spacing value. |
deleteNamedValue | This action deletes a named spacing value. |
Instance Actions | |
delete | This action deletes the spacing. |
getName | This action returns the name of the spacing if it is a named spacing value. |
pw::Spacing createNamedValue ?name ?value??
This action defines a named spacing value.
name | The optional name to assign the spacing value. The name may be altered if the name duplicates another named spacing value. The name should not be an empty string, a string that could be interpreted as a float value, or a string that starts with the Pointwise namespace qualifier “::pw”. |
value | This optional argument defines the initial value. It should be a float value greater than or equal to 0. The default value is 0. |
This function returns a string result representing the name of the newly created named spacing value. It may be different from the name passed in as the optional first argument.
pw::Spacing getNamedValueNames
This action returns a list of named spacing values.
This function takes no parameters.
This command returns a list of the names of the named spacing values. Each entry in the list is a string value.
pw::Spacing getNamedValue name
This action returns value of a named spacing value.
name | This argument is the name of the named spacing value to query. |
This command returns the float value of the named spacing value.
pw::Spacing changeNamedValue name value
This action changes the value of a named spacing value.
name | This argument is the name of the named spacing value to change. |
value | This parameter is the new float value to assign to the named spacing value. The value should be a non-negative number. |
This command returns nothing.
pw::Spacing renameNamedValue oldname newname
This action renames a named spacing value.
oldname | This argument is the name of the named spacing value to change. |
newname | This parameter is the new string name for the named spacing value. The name may be modified to avoid conflicts. The name should not be an empty string, a string that could be interpreted as a float value, or a string that starts with the Pointwise namespace qualifier “::pw”. |
This command returns the new name of the named spacing value as a string. It may be a modified form of the newname value if there was a naming conflict.
$spacing delete
This action deletes the spacing. This is necessary if the spacing has not been added to a pw::Distribution. Calling delete on a spacing after it has been added, will generate an error.
none
This action returns nothing.
$spacing getName
This action returns the name of the spacing if it is a named spacing value. It returns an empty string otherwise.
none
If the spacing object is a named spacing value, the return value will be a string representing the name. Otherwise, an empty string is returned.
This action defines a named spacing value.
pw::Spacing createNamedValue ?name ?value??
This action returns a list of named spacing values.
pw::Spacing getNamedValueNames
This action returns value of a named spacing value.
pw::Spacing getNamedValue name
This action changes the value of a named spacing value.
pw::Spacing changeNamedValue name value
This action renames a named spacing value.
pw::Spacing renameNamedValue oldname newname
This action deletes a named spacing value.
pw::Spacing deleteNamedValue name
This action deletes the spacing.
$spacing delete
This action returns the name of the spacing if it is a named spacing value.
$spacing getName