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

.. oe:namespace:: OESystem


.. meta::
   :keywords: OEConstParameter, ConstParameter


.. _OESystem_OEConstParameter:

.. oe:class:: OEConstParameter

   .. oe:api::

      class OEConstParameter : public OEUIntParameter

   The :ref:`OEConstParameter <OESystem_OEConstParameter>` represents parameter that has ``unsigned`` value.
   Unlike :ref:`OEUIntParameter <OESystem_OEUIntParameter>`, however, this parameter requires a set
   of constants defined in terms of <unsigned, std::string> pairs as legal entries.

   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>`

   Following methods are publicly inherited from :ref:`OETypedParameter <OESystem_OETypedParameter>`:
    * :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>`

   Following methods are publicly inherited from :ref:`OEPODParameter <OESystem_OEPODParameter>`:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   The :ref:`OEConstParameter <OESystem_OEConstParameter>` class defines the following public methods:
    * :ref:`AddLegalEntry <OESystem_OEConstParameter_AddLegalEntry>`

   .. oe:method:: Constructors

      .. oe:language:: c++ java csharp

         .. oe:api::

            OEConstParameter()
            OEConstParameter(const std::string& name)
            OEConstParameter(const std::string& name, const unsigned defValue,
                             const std::string& defKey)
            OEConstParameter(const OEConstParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEConstParameter(name: str) -> OEConstParameter
            OEConstParameter(name: str, defValue: int, defKey: str) -> OEConstParameter
            OEConstParameter() -> OEConstParameter
            OEConstParameter(arg2: OEConstParameter) -> OEConstParameter

      Default and copy constructors.

      Constructs an :ref:`OEConstParameter <OESystem_OEConstParameter>` instance using the specified set of parameters.

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

      .. oe:api::

         OEConstParameter &operator=(const OEConstParameter &)

      The assignment operator.

   .. _OESystem_OEConstParameter_AddLegalEntry:

      Assignment operator.


   .. oe:method:: AddLegalEntry

      .. oe:language:: c++ java csharp

         .. oe:api::

            bool AddLegalEntry(const unsigned value, const std::string& key)

      .. oe:language:: python

         .. oe:api:: python

            AddLegalEntry(value: int, key: str) -> bool

      Adds a legal pair, defining valid constants for the parameter.
