AFXFloatKeyword

This class is designed for the command keywords that have floating-point values.


AFXFloatKeyword(command, name, isRequired=False, defaultValue=FLOAT_DEFAULT, precision=6)

Constructor.

ArgumentTypeDefaultDescription
commandAFXCommand Host command.
nameString Keyword name.
isRequiredBoolFalseTrue if the keyword is a required argument of the command.
defaultValueFloatFLOAT_DEFAULTDefault value.
precisionInt6Precision for converting the keyword's floating-point value to a text string.


getPrecision()

Returns the precision that is used for converting the keyword's floating-point value to a text string.


getTypeName()

Returns the name of the keyword type.

Implements AFXKeyword.


getValue()

Returns the keyword's current value, or zero if the content expression is invalid.


getValueAsString()

Returns the text string that represents the keyword's current value.

Implements AFXKeyword.


isValueChanged()

Returns True if the keyword value differs from its previous value.

Implements AFXKeyword.


setDefaultValue(defaultValue)

Sets the keyword's default value.

ArgumentTypeDefaultDescription
defaultValueString Default value.


setDefaultValue(defaultValue)

Sets the keyword's default value.

ArgumentTypeDefaultDescription
defaultValueFloat Default value.


setPrecision(precision)

Sets the precision that is used for converting the keyword's floating-point value to a text string.

ArgumentTypeDefaultDescription
precisionInt  


setValue(newValue)

Sets the keyword's current value.

ArgumentTypeDefaultDescription
newValueString New value.


setValue(newValue)

Sets the keyword's current value.

ArgumentTypeDefaultDescription
newValueFloat New value.


setValueToDefault(ignoreUnspecified=False)

Sets the keyword value to its default.

ArgumentTypeDefaultDescription
ignoreUnspecifiedBoolFalseIgnore setting the value if the default is unspecified.


setValueToPrevious()

Sets the keyword value to its previous value.

Implements AFXKeyword.


syncPreviousValue()

Sets the keyword's previous value to its current value.

Implements AFXKeyword.