OEConstParameter¶
Attention
This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.
class OEConstParameter : public OEUIntParameter
The OEConstParameter
represents parameter that has unsigned
value.
Unlike OEUIntParameter
, however, this parameter requires a set
of constants defined in terms of <unsigned, std::string> pairs as legal entries.
- Following methods are publicly inherited from
OEParameter
: AddAlias
andGetAliases
GetKeyless
andSetKeyless
IsSet
andIsSetToString
- Following methods are publicly inherited from
OETypedParameter
: AddDefault
,GetDefault
,GetDefaults
andSetDefault
- Following methods are publicly inherited from
OEPODParameter
: - The
OEConstParameter
class defines the following public methods: AddLegalEntry
Constructors¶
OEConstParameter()
OEConstParameter(const std::string& name)
OEConstParameter(const std::string& name, const unsigned defValue, const std::string& defKey)
OEConstParameter(const OEConstParameter&)
Default and copy constructors.
Constructs an OEConstParameter
instance using the specified set of parameters.
AddStringDefault¶
bool AddLegalEntry(const unsigned value, const std::string& key)
Adds a legal pair, defining valid constants for the parameter.