.. include:: ../../toolkit-substitutions

.. oe:namespace:: OESystem


.. meta::
   :keywords: OEMultiParameter, MultiParameter


.. _OESystem_OEMultiParameter:

.. oe:class:: OEMultiParameter

   .. oe:api::

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

   OWMultiParameter represents parametera that have three different representations
   of the values.  The three representations are an unsigned , a std::string , and an object representation.

   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:`OEMultiParameter <OESystem_OEMultiParameter>` class defines the following public methods:
    * :oe:meth:`AddLegalEntry<OESystem::OEMultiParameter::AddLegalEntry>` 
    * :oe:meth:`GetDefault<OESystem::OEMultiParameter::GetDefault>` and
      :oe:meth:`SetDefault<OESystem::OEMultiParameter::SetDefault>` 
    * :oe:meth:`GetSetting<OESystem::OEMultiParameter::GetSetting>`
    * :oe:meth:`GetValue<OESystem::OEMultiParameter::GetValue>` and
      :oe:meth:`SetValue<OESystem::OEMultiParameter::SetValue>`


   .. oe:method:: Constructors

      .. oe:api::

         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.

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

      .. oe:api::

         OEMultiParameter& operator=(const OEMultiParameter &)

      The assignment operator.

   ..   _OESystem_OEMultiParameter_AddLegalEntry:

      Assignment operator.


   .. oe:method:: AddLegalEntry

      .. oe:api::

        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.

   ..   _OESystem_OEMultiParameter_GetDefault:


   .. oe:method:: GetDefault

      .. oe:api::

         TT* GetDefault() const

      Returns the current default value of the parameter.

   ..   _OESystem_OEMultiParameter_GetSetting:

   .. oe:method:: GetSetting

      .. oe:api::

         TT* GetSetting() const

      Returns the current setting of the parameter.

   ..   _OESystem_OEMultiParameter_GetValue:


   .. oe:method:: GetValue

      .. oe:api::

         TT* GetValue() const

      Returns the current user-defined value of the parameter.

   ..   _OESystem_OEMultiParameter_SetDefault:


   .. oe:method:: SetDefault

      .. oe:api::

         bool SetValue(const unsigned)

      Sets the default value of the parameter.

   ..   _OESystem_OEMultiParameter_SetValue:


   .. oe:method:: SetValue

      .. oe:api::

         bool SetValue(const unsigned)
         bool SetValue(const std::string&)
         bool SetValue(const TT&)
         bool SetValue(OEPlatform::oeistream& ifs)

      Sets the user-defined value of the parameter.

