OEMultiParameter

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.

template<class TT>
template <class TT> class OEMultiParameter : public OESystem::OEPointerParameter<TT>

The OEMultiParameter represents parameter that has three different representation of the values. The three representations are an unsigned , a std::string , and an object representation.

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

The OEMultiParameter class defines the following public methods:

• AddLegalEntry
• GetDefault and SetDefault
• GetSetting
• GetValue and SetValue

Constructors

OEMultiParameter()
OEMultiParameter(const std::string& name, const bool customAllowed)
OEMultiParameter(const OEMultiParameter&)

Default and copy constructors.

Constructs an OEMultiParameter instance using the specified set of parameters. The second argument in the second constructor represents if a custom object (not already defined as a legal entry) could be used as a parameter.

operator=

OEMultiParameter &operator=(const OEMultiParameter &)

The assignment operator.

AddLegalEntry

bool AddLegalEntry(const unsigned idxKey, const std::string& strKey, const TT& lib)

Add new legal entry for this parameter. The three argument value represents the three representations of the same legal value.

GetDefault

TT* GetDefault() const

Returns the current default value of the parameter.

GetSetting

TT* GetSetting() const

Returns the current setting of the parameter.

GetValue

TT* GetValue() const

Returns the current user-defined value of the parameter.

SetDefault

bool SetValue(const unsigned)

Sets the default value of the parameter.

SetValue

bool SetValue(const unsigned)
bool SetValue(const std::string&)
bool SetValue(const TT&)

Sets the user-defined value of the parameter.