OEBoolParameter¶
Attention
This is a preliminary API until Spring 2021 and may be improved based on user feedback. It is currently available in C++ and Python.
class OEBoolParameter : public OEPODParameter<bool>
The OEBoolParameter represents parameter that has boolean value.
- Following methods are publicly inherited from OEParameter:
- AddAlias and GetAliases
- AddDetail and GetDetail
- AddIllegalRange and GetIllegalRanges
- AddIllegalValue and GetIllegalValues
- AddLegalRange and GetLegalRanges
- AddStringDefault , GetStringDefault and GetStringDefaults
- AddStringValue , GetStringValue and GetStringValues
- ClearDefaults
- ClearValues
- CreateCopy
- GetBrief and SetBrief
- GetHasDefault
- GetHasValue
- GetIsList and SetIsList
- GetKeyless and SetKeyless
- GetName and SetName
- GetOrderPriority and SetOrderPriority
- GetVisibility and SetVisibility
- IsLegalString
- IsSet and IsSetToString
- Following methods are publicly inherited from OETypedParameter:
- AddDefault , GetDefault , GetDefaults and SetDefault
- GetSetting and GetSettings
- AddValue , GetValue , GetValues and SetValue
- Following methods are publicly inherited from OEPODParameter:
Constructors¶
OEBoolParameter()
OEBoolParameter(const std::string& name)
OEBoolParameter(const std::string& name, const bool default)
OEBoolParameter(const OEBoolParameter&)
Default and copy constructors.
Constructs an OEBoolParameter instance using the specified set of parameters.