OEPODParameter

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 OEPODParameter : public OETypedParameter<TT>

The OEPODParameter is an abstract base class, derived from OETypedParameter. This is a templated class that provides type-specific implementation of parameters that has plain-old-data (POD) type 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

The OEPODParameter class defines the following public methods:

• GetDefaultsVector
• GetSettingsVector
• GetValuesVector

The following classes derive from this class:

• OEBoolParameter
• OEDoubleParameter
• OEFloatParameter
• OEIntParameter
• OEStringParameter
• OEUIntParameter

GetDefaultsVector

std::vector<TT> GetDefaultsVector() const

Returns a vector of values containing the current defaults.

GetSettingsVector

std::vector<TT> GetSettingsVector() const

Returns a vector of values containing the current settings.

GetValuesVector

std::vector<TT> GetValuesVector() const

Returns a vector of values containing the current user-defined values.