OEConstParameter

Attention

This is a preliminary API until Fall 2021 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 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:

• GetDefaultsVector

• GetSettingsVector

• GetValuesVector

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.

operator=

OEConstParameter &operator=(const OEConstParameter &)

The assignment operator.

AddStringDefault

bool AddLegalEntry(const unsigned value, const std::string& key)

Adds a legal pair, defining valid constants for the parameter.