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

.. oe:namespace:: OEChem


.. meta::
   :keywords: OEMCSFuncParameter, MCSFuncParameter

..  _OEChem_OEMCSFuncParameter:

.. oe:class:: OEMCSFuncParameter

   .. oe:api::

      class OEMCSFuncParameter : public OESystem::OEMultiParameter<OEChem::OEMCSFunc>

   OEMCSFuncParameter represents a parameter that has a value of type
   :oe:cls:`OEChem::OEMCSFunc`.

   Following methods are publicly inherited from :oe:cls:`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 :oe:cls:`OESystem::OEMultiParameter`:
    * :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:language:: c++ java csharp

         .. oe:api::

            OEMCSFuncParameter()
            OEMCSFuncParameter(const std::string& name)
            OEMCSFuncParameter(const OEMCSFuncParameter&)

      .. oe:language:: python

         .. oe:api:: python

            OEMCSFuncParameter(name: str) -> OEMCSFuncParameter
            OEMCSFuncParameter(arg2: OEMCSFuncParameter) -> OEMCSFuncParameter

      Default and copy constructors.

      Constructs an OEMCSFuncParameter instance using the specified set of parameters.

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

      .. oe:api::

         OEMCSFuncParameter &operator=(const OEMCSFuncParameter &)

      The assignment operator.

      Assignment operator.

