OETypedParameter

template<class TT>
class OETypedParameter : public OEParameter

The OETypedParameter is an abstract base class. This is a templated class that provides type-specific implementation of parameters.

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 OETypedParameter class defines the following public methods:

• AddDefault , GetDefault , GetDefaults and SetDefault

• GetSetting and GetSettings

• AddValue , GetValue , GetValues and SetValue

The following classes derive from this class:

• OEPODParameter

AddDefault

bool AddDefault(const TT& dflt)

Add the specified value as a default for the parameter.

AddValue

bool AddValue(const TT& value)

Add the specified value as a user-defined value for the parameter.

GetDefault

bool GetDefault(TT& dflt, const unsigned idx = 0) const

Returns the default value of the parameter at the specified index, if available. See AddDefault method.

GetDefaults

OEIterBase<const TT>* GetDefaults() const = 0

See AddDefault method.

GetSetting

bool GetSetting(TT& setting, unsigned int idx = 0) const

Returns the current settings of the parameter at the specified index, if available.

GetSettings

OEIterBase<const TT>* GetSettings() const

Returns all the current settings of the parameter.

GetValue

bool GetValue(TT& value, const unsigned idx = 0) const

Returns the user defined value of the parameter at the specified index, if available. See AddValue method.

GetValues

OEIterBase<const TT>* GetValues() const = 0

See AddValue method.

SetDefault

bool SetDefault(const TT& dflt)

Sets the parameter default value. Overrides any existing defaults. See AddDefault method.

SetValue

bool SetValue(const TT& value)

Sets the parameter user-defined value. Overrides any existing user-defined value. See AddDefault method.