.. oe:namespace:: OESystem



.. meta::
   :keywords: OETypedParameter, TypedParameter


.. _OESystem_OETypedParameter:

.. oe:class:: OETypedParameter

   .. oe:api::


      template<class TT>
      class OETypedParameter : public OEParameter

   The :ref:`OETypedParameter <OESystem_OETypedParameter>` is an abstract base class. This is a templated
   class that provides type-specific implementation of parameters.

   Following methods are publicly inherited from :ref:`OEParameter <OESystem_OEParameter>`:
    * :oe:meth:`AddAlias<OESystem::OEParameter::AddAlias>` and
      :oe:meth:`GetAliases<OESystem::OEParameter::GetAliases>` 
    * :oe:meth:`AddDetail<OESystem::OEParameter::AddDetail>` and
      :oe:meth:`GetDetail<OESystem::OEParameter::GetDetail>`
    * :oe:meth:`AddIllegalRange<OESystem::OEParameter::AddIllegalRange>` and
      :oe:meth:`GetIllegalRanges<OESystem::OEParameter::GetIllegalRanges>`
    * :oe:meth:`AddIllegalValue<OESystem::OEParameter::AddIllegalValue>` and
      :oe:meth:`GetIllegalValues<OESystem::OEParameter::GetIllegalValues>`
    * :oe:meth:`AddLegalRange<OESystem::OEParameter::AddLegalRange>` and
      :oe:meth:`GetLegalRanges<OESystem::OEParameter::GetLegalRanges>`
    * :oe:meth:`AddStringDefault<OESystem::OEParameter::AddStringDefault>` ,
      :oe:meth:`GetStringDefault<OESystem::OEParameter::GetStringDefault>` and
      :oe:meth:`GetStringDefaults<OESystem::OEParameter::GetStringDefaults>`
    * :oe:meth:`AddStringValue<OESystem::OEParameter::AddStringValue>` ,
      :oe:meth:`GetStringValue<OESystem::OEParameter::GetStringValue>` and
      :oe:meth:`GetStringValues<OESystem::OEParameter::GetStringValues>`
    * :oe:meth:`ClearDefaults<OESystem::OEParameter::ClearDefaults>`
    * :oe:meth:`ClearValues<OESystem::OEParameter::ClearValues>`
    * :oe:meth:`CreateCopy<OESystem::OEParameter::CreateCopy>`
    * :oe:meth:`GetBrief<OESystem::OEParameter::GetBrief>` and
      :oe:meth:`SetBrief<OESystem::OEParameter::SetBrief>`
    * :oe:meth:`GetHasDefault<OESystem::OEParameter::GetHasDefault>`
    * :oe:meth:`GetHasValue<OESystem::OEParameter::GetHasValue>`
    * :oe:meth:`GetIsList<OESystem::OEParameter::GetIsList>` and
      :oe:meth:`SetIsList<OESystem::OEParameter::SetIsList>`
    * :oe:meth:`GetKeyless<OESystem::OEParameter::GetKeyless>` and
      :oe:meth:`SetKeyless<OESystem::OEParameter::SetKeyless>`
    * :oe:meth:`GetName<OESystem::OEParameter::GetName>` and
      :oe:meth:`SetName<OESystem::OEParameter::SetName>`
    * :oe:meth:`GetOrderPriority<OESystem::OEParameter::GetOrderPriority>` and
      :oe:meth:`SetOrderPriority<OESystem::OEParameter::SetOrderPriority>`
    * :oe:meth:`GetVisibility<OESystem::OEParameter::GetVisibility>` and
      :oe:meth:`SetVisibility<OESystem::OEParameter::SetVisibility>`
    * :oe:meth:`IsLegalString<OESystem::OEParameter::IsLegalString>`
    * :oe:meth:`IsSet<OESystem::OEParameter::IsSet>` and
      :oe:meth:`IsSetToString<OESystem::OEParameter::IsSetToString>`

   The :ref:`OETypedParameter <OESystem_OETypedParameter>` class defines the following public methods:
    * :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` ,
      :oe:meth:`GetDefault<OESystem::OETypedParameter::GetDefault>` ,
      :oe:meth:`GetDefaults<OESystem::OETypedParameter::GetDefaults>` and
      :oe:meth:`SetDefault<OESystem::OETypedParameter::SetDefault>`
    * :oe:meth:`GetSetting<OESystem::OETypedParameter::GetSetting>` and
      :oe:meth:`GetSettings<OESystem::OETypedParameter::GetSettings>`
    * :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` ,
      :oe:meth:`GetValue<OESystem::OETypedParameter::GetValue>` ,
      :oe:meth:`GetValues<OESystem::OETypedParameter::GetValues>` and
      :oe:meth:`SetValue<OESystem::OETypedParameter::SetValue>`

   The following classes derive from this class:
    * :ref:`OEPODParameter <OESystem_OEPODParameter>`

   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OETypedParameter & operator=(const OETypedParameter &)

      Assignment operator.


   .. oe:method:: AddDefault

      .. oe:api::

         bool AddDefault(const TT& dflt)

      Add the specified value as a default for the parameter.

   .. oe:method:: AddValue

      .. oe:api::

         bool AddValue(const TT& value)

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

   .. oe:method:: GetDefault

      .. oe:api::

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

      Returns the default value of the parameter at the specified index, if available. See 
      :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

   .. oe:method:: GetDefaults

      .. oe:api::

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

      See :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

   .. oe:method:: GetSetting

      .. oe:api::

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

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

   .. oe:method:: GetSettings

      .. oe:api::

         OEIterBase<const TT>* GetSettings() const

      Returns all the current settings of the parameter.

   .. oe:method:: GetValue

      .. oe:api::

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

      Returns the user defined value of the parameter at the specified index, if available. See 
      :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` method.

   .. oe:method:: GetValues

      .. oe:api::

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

      See :oe:meth:`AddValue<OESystem::OETypedParameter::AddValue>` method.

   .. oe:method:: SetDefault

      .. oe:api::

         bool SetDefault(const TT& dflt)

      Sets the parameter default value. Overrides any existing defaults.
      See :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

   .. oe:method:: SetValue

      .. oe:api::

         bool SetValue(const TT& value)

      Sets the parameter user-defined value. Overrides any existing user-defined value.
      See :oe:meth:`AddDefault<OESystem::OETypedParameter::AddDefault>` method.

