awSupport.Parameter Class Reference
Public Member Functions |
|
| str | getValueAsString () |
| Access the parameter's value. |
|
| bool | setValueAsString (str value) |
| __init__ () | |
| ParameterRef | clone () |
| aw::Reference | as () |
| aw::Reference | as () |
| Parameter::Type | getType () |
| str | getName () |
| bool | hasProperty (Property p) |
| bool | setProperty (Property p, bool state) |
| float | getValueAsDouble (int index, bool ok) |
| Return the value at the given index as a
double if: 1) the given index is valid for the Parameter.Type.
|
|
| float | getValueAsDouble (int index, float defaultValue) |
| Same as getValueAsDouble( index, ok ), but
returns the defaultValue if retrieval was not ok. |
|
| bool | setValueAsDouble (int index, float value) |
| Sets the specified double inside the
ValueParameter's value. |
|
| bool | operator== (Parameter parameter) |
| bool | operator!= (Parameter parameter) |
| bool | getValueAsAffineMatrix (awLinear::AffineMatrix) |
| A few convenience methods for setting all
values when dealing with the affine matrix case. |
|
| bool | setValueAsAffineMatrix (awLinear::AffineMatrix) |
| bool | getValueAsProjMatrix (awLinear::ProjMatrix) |
| bool | setValueAsProjMatrix (awLinear::ProjMatrix) |
| bool | checkConnectAssetValid () |
| str | getTypeAsString (Parameter::Type type) |
| Parameter::Type | getTypeFromString (str stringType) |
| parseFilenames (str stringToParse, str filename1, str filename2) | |
| Parses the given string delimited by this
separator into its two parts. |
|
Protected Member Functions |
|
| __init__ (Parameter src) | |
| __del__ () | |
| recomputeValueAsString () | |
Protected Attributes |
|
| str | myValueAsString |
| bool | myValueAsStringValid |
Member Function Documentation
| str awSupport.Parameter.getValueAsString | ( | ) |
Access the parameter's value.
It does not matter whether the Parameter is of type string or not -- you can always read/write it's string representation through getValueAsString and setValueAsString.
| bool awSupport.Parameter.setValueAsString | ( | str | value | ) |
| awSupport.Parameter.__init__ | ( | ) |
| ParameterRef awSupport.Parameter.clone | ( | ) |
| aw::Reference awSupport.Parameter.as | ( | ) |
| aw::Reference awSupport.Parameter.as | ( | ) |
| Parameter::Type awSupport.Parameter.getType | ( | ) |
| str awSupport.Parameter.getName | ( | ) |
| bool awSupport.Parameter.hasProperty | ( | Property | p | ) |
| bool awSupport.Parameter.setProperty | ( | Property | p, |
| bool | state | ||
| ) |
| float awSupport.Parameter.getValueAsDouble | ( | int | index, |
| bool | ok | ||
| ) |
Return the value at the given index as a double if: 1) the given index is valid for the Parameter.Type.
and 2) the value at the given index is valid. Otherwise, return 0 and set the boolean to false.
| float awSupport.Parameter.getValueAsDouble | ( | int | index, |
| float | defaultValue | ||
| ) |
Same as getValueAsDouble( index, ok ), but returns the defaultValue if retrieval was not ok.
| bool awSupport.Parameter.setValueAsDouble | ( | int | index, |
| float | value | ||
| ) |
Sets the specified double inside the ValueParameter's value.
Note that this will affect the result of getValueAsString Returns false if the parameter is not of the right type or if it's not mutable and the parameter will remain unmodified.
| bool awSupport.Parameter.operator== | ( | Parameter | parameter | ) |
| bool awSupport.Parameter.operator!= | ( | Parameter | parameter | ) |
| bool awSupport.Parameter.getValueAsAffineMatrix | ( | awLinear::AffineMatrix | ) |
A few convenience methods for setting all values when dealing with the affine matrix case.
| bool awSupport.Parameter.setValueAsAffineMatrix | ( | awLinear::AffineMatrix | ) |
| bool awSupport.Parameter.getValueAsProjMatrix | ( | awLinear::ProjMatrix | ) |
| bool awSupport.Parameter.setValueAsProjMatrix | ( | awLinear::ProjMatrix | ) |
| bool awSupport.Parameter.checkConnectAssetValid | ( | ) |
| str awSupport.Parameter.getTypeAsString | ( | Parameter::Type | type | ) |
| Parameter::Type awSupport.Parameter.getTypeFromString | ( | str | stringType | ) |
| awSupport.Parameter.parseFilenames | ( | str | stringToParse, |
| str | filename1, | ||
| str | filename2 | ||
| ) |
Parses the given string delimited by this separator into its two parts.
| awSupport.Parameter.__init__ | ( | Parameter | src | ) | [protected] |
| awSupport.Parameter.__del__ | ( | ) | [protected] |
| awSupport.Parameter.recomputeValueAsString | ( | ) | [protected] |
Member Data Documentation
str
awSupport.Parameter.myValueAsString
[protected] |
bool
awSupport.Parameter.myValueAsStringValid
[protected] |
