ParameterDefinition Objects

Describes a parameter which affects the behaviour of some Modeler API objects. A parameter definition is obtained from a ParameterProvider. The parameter name is unique within the provider.

Parameters are modified through the provider. A ParameterDefinition instance may be a snapshot of a parameter definition at the time it was obtained from the provider and need not reflect subsequent modifications.

p.getFalseFlag() : Object

Returns the false indicator for this flag parameter. Returns None if the parameter type is other than ParameterType.FLAG or if no false value has been declared for the flag.

p.getLowerBound() : Object

Returns a lower bound on the valid values of this parameter. Returns None if the parameter type is other than ParameterType.RANGE or if no lower bound has been declared for the range.

p.getParameterLabel() : string

Returns a label for this parameter. The default label is the empty string.

p.getParameterName() : string

Returns the name of this parameter. The name is unique within the parameter provider.

p.getParameterStorage() : ParameterStorage

Returns the storage type of this parameter.

p.getParameterType() : ParameterType

Returns the measure of this parameter.

p.getParameterValue() : Object

Returns the value of this parameter.

p.getSetValues() : Object[]

Returns the valid values of this parameter. Returns None if the parameter type is other than ParameterType.SET or if no values have been declared for the set.

p.getTrueFlag() : Object

Returns the true indicator for this flag parameter. Returns None if the parameter type is other than ParameterType.FLAG or if no true value has been declared for the flag.

p.getUpperBound() : Object

Returns an upper bound on the valid values of this parameter. Returns None if the parameter type is other than ParameterType.RANGE or if no upper bound has been declared for the range.

p.isValidValue(value) : boolean

value (Object) : the value

Returns True if the specified value is valid for this parameter. The value must be compatible with the parameter storage type and with the parameter values when they are specified.