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

.. oe:namespace:: OESystem


.. meta::
   :keywords: OEPODParameter, PODParameter


.. _OESystem_OEPODParameter:

.. oe:class:: OEPODParameter

   .. oe:api::

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

   The :ref:`OEPODParameter <OESystem_OEPODParameter>` is an abstract base class, derived from :ref:`OETypedParameter <OESystem_OETypedParameter>`. This is a templated class that provides type-specific
   implementation of parameters that has plain-old-data (POD) type value.

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

   The :ref:`OEPODParameter <OESystem_OEPODParameter>` class defines the following public methods:
    * :oe:meth:`GetDefaultsVector<OESystem::OEPODParameter::GetDefaultsVector>`
    * :oe:meth:`GetSettingsVector<OESystem::OEPODParameter::GetSettingsVector>`
    * :oe:meth:`GetValuesVector<OESystem::OEPODParameter::GetValuesVector>`

   The following classes derive from this class:
    * :ref:`OEBoolParameter <OESystem_OEBoolParameter>`
    * :ref:`OEDoubleParameter <OESystem_OEDoubleParameter>`
    * :ref:`OEFloatParameter <OESystem_OEFloatParameter>`
    * :ref:`OEIntParameter <OESystem_OEIntParameter>`
    * :ref:`OEStringParameter <OESystem_OEStringParameter>`
    * :ref:`OEUIntParameter <OESystem_OEUIntParameter>`

   ..   _OESystem_GetDefaultsVector:

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

      .. oe:api::

         OEPODParameter & operator=(const OEPODParameter &)

      Assignment operator.


   .. oe:method:: GetDefaultsVector

      .. oe:api::

         std::vector<TT> GetDefaultsVector() const

      Returns a vector of values containing the current defaults.

   ..   _OESystem_GetSettingsVector:

   .. oe:method:: GetSettingsVector

      .. oe:api::

         std::vector<TT> GetSettingsVector() const

      Returns a vector of values containing the current settings.

   ..   _OESystem_GetValuesVector:

   .. oe:method:: GetValuesVector

      .. oe:api::

         std::vector<TT> GetValuesVector() const

      Returns a vector of values containing the current user-defined values.
