OETypedParameter

template<class TT>
template <class TT> class OETypedParameter : public OEParameter

This class represents OETypedParameter.

An abstract base class derived from OEParameter which is templated upon the parameter type and adds member functions to access the actual value and default settings of the parameter.

The following methods are publicly inherited from OEParameter:

AddAlias GetHasValue Load
AddDetail GetIllegalRanges LoadDefault
AddIllegalRange GetIllegalValues LoadValue
AddIllegalValue GetIsList ReadValueAndDefaultBinary
AddLegalRange GetKeyless SetBrief
AddLegalValue GetLegalRanges SetCommand
AddStringDefault GetLegalValues SetElement
AddStringValue GetName SetIsList
ClassID GetOrderPriority SetKeyless
ClearDefaults GetRequired SetName
ClearValues GetStringDefault SetOrderPriority
CreateCopy GetStringDefaults SetRequired
GetAliases GetStringValue SetStringDefault
GetBrief GetStringValues SetStringValue
GetCommand GetVisibility SetVisibility
GetDetail IsLegalString TypedParameterTypeID
GetElement IsSet ValueAndDefaultBinarySize
GetHasDefault IsSetToString WriteValueAndDefaultBinary

AddDefault

bool AddDefault(const TT &dflt)=0

AddValue

bool AddValue(const TT &value)=0

GetDefault

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

Retrieves the current default of the parameter. Returns true if the parameter’s default is set and the get succeeded and returns false otherwise.

GetDefaults

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

GetSetting

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

Retrieves the current setting of the parameter. If the value is set, then the parameter’s value is retrieved, otherwise the current default of the parameter is retrieved. Returns false if neither the value nor the default value were set for this parameter.

GetSettings

OEIterBase<const TT> *GetSettings() const

GetValue

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

Retrieves the current value of the parameter. Returns true if the parameter’s value is set and the get succeeded and returns false otherwise.

GetValues

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

SetDefault

bool SetDefault(const TT &dflt)=0

Sets the parameter default value. Returns true if successful and false otherwise.

SetValue

bool SetValue(const TT &value)=0

Sets the parameter value. Returns true if successful and false otherwise.

TypedParameterTypeID

const void *TypedParameterTypeID() const