float param
Attributes
PRIVATE_VISIBILITY: Literal
PROTECTED_VISIBILITY: Literal
PUBLIC_VISIBILITY: Literal
additional_info: Optional
default_value: Optional
human_name: Optional
optional: bool
short_description: Optional
visibility: Literal
Functions
__INIT__
default_value :
Optional
Default value, if None, and optional is false, the config is mandatory
If a value is provided there is no need to set the optional
Setting optional to True, allows default None value
optional :
bool
- False
See default value
Visibility :
Literal
- public
Visibility of the param, see doc on type ParamSpecVisibilty for more info
human_name :
Optional
Human readable name of the param, showed in the interface
short_description :
Optional
Description of the param, showed in the interface
allowed_values :
Optional
If present, the param value must be in the array
min_value :
Optional
max_value :
Optional
BUILD
Method call before the value is used (in task or view) to apply some transformation if needed by the ParamSpec. This does not affect the value in the database.
value :
Any
Return type :
Any
GET_DEFAULT_VALUE
Return type :
ParamSpecType
TO_DTO
Return type :
ParamSpecDTO
TO_SIMPLE_DTO
Return type :
ParamSpecSimpleDTO
VALIDATE
Validate the value of the param and return the modified value if needed. This method is called when the param is set in the config before saving it in the database. The returned value must be serializable in json.l
value :
Any
Return type :
float
EMPTY - @classmethod
Return type :
ParamSpec
GET_ADDITIONAL_INFOS - @classmethod
Return type :
Dict
GET_DEFAULT_VALUE_PARAM_SPEC - @classmethod
Return type :
FloatParam
GET_STR_TYPE - @classmethod
Return type :
ParamSpecTypeStr
LOAD_FROM_DTO - @classmethod
spec_dto :
ParamSpecDTO
Return type :
ParamSpec
TO_PARAM_SPEC_INFO_SPECS - @classmethod
Return type :
ParamSpecInfoSpecs