OEConstParameter

Attention

PRELIMINARY-IMAGE 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 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:
Following methods are publicly inherited from OETypedParameter:
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.

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.