.. oe:namespace:: OEShape

.. meta::
   :keywords: OEAnalyticShapeFunc, AnalyticShapeFunc


.. _OEShape_OEAnalyticShapeFunc:

.. oe:class:: OEAnalyticShapeFunc

   .. oe:api::


      class OEAnalyticShapeFunc : public OEShapeFunc

   The :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` class defines shape overlap between a reference
   object and a fit molecule, using the *Analytic* method.

   .. _figure_OEAnalyticShapeFunc_Hierarchy:

   .. figure:: ../images/OEAnalyticShapeFunc.*
      :align:  center

   The following methods are publicly inherited from :ref:`OEFunc0 <OEOpt_OEFunc0>`:
    * :oe:meth:`operator()<OEOpt::OEFunc0::operator()>`         
    * :oe:meth:`GetFComponents<OEOpt::OEFunc0::GetFComponents>` 
    * :oe:meth:`NumVar<OEOpt::OEFunc0::NumVar>`

   The following methods are publicly inherited from :ref:`OEFunc1 <OEOpt_OEFunc1>`:
    * :oe:meth:`operator()<OEOpt::OEFunc1::operator()>`
   
   The following methods are publicly inherited from :ref:`OEMolFunc <OEMolPotential_OEMolFunc>`:
    * :oe:meth:`GetInteractions<OEMolPotential::OEMolFunc::GetInteractions>`   
    * :oe:meth:`Setup<OEMolPotential::OEMolFunc::Setup>`

   The following methods are publicly inherited from :ref:`OEOverlapFuncBase <OEShape_OEOverlapFuncBase>`:
    * :oe:meth:`Overlap<OEShape::OEOverlapFuncBase::Overlap>` 
    * :oe:meth:`SetupFlex<OEShape::OEOverlapFuncBase::SetupFlex>`
    * :oe:meth:`SetupRef<OEShape::OEOverlapFuncBase::SetupRef>`

   The following methods are publicly inherited from :ref:`OEShapeFunc <OEShape_OEShapeFunc>`:
    * :oe:meth:`GetShapeOptions<OEShape::OEShapeFunc::GetShapeOptions>`

   The :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` class defines the following public methods:
    * :oe:meth:`GetAnalyticOptions<OEShape::OEAnalyticShapeFunc::GetAnalyticOptions>`

   .. oe:method:: Constructors

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

         .. oe:api::

            OEAnalyticShapeFunc(const OEShapeOptions& argOptions = OEShapeOptions())
            OEAnalyticShapeFunc(const OEAnalyticOptions&)
            OEAnalyticShapeFunc(const OEShapeOptions& argShape,
                                const OEAnalyticOptions& argAnalytic)
            OEAnalyticShapeFunc(const OEAnalyticShapeFunc&)

      .. oe:language:: python

         .. oe:api:: python

            OEAnalyticShapeFunc(argOptions: OEShapeOptions = OEShapeOptions()) -> OEAnalyticShapeFunc
            OEAnalyticShapeFunc(argOptions: OEAnalyticOptions) -> OEAnalyticShapeFunc
            OEAnalyticShapeFunc(argShape: OEShapeOptions,
                                argAnalytic: OEAnalyticOptions) -> OEAnalyticShapeFunc
            OEAnalyticShapeFunc(argFunc: OEAnalyticShapeFunc) -> OEAnalyticShapeFunc

      Default and copy constructors.

      Constructs an :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>` instance using the specified set of parameters.

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

      .. oe:api::

         OEAnalyticShapeFunc &operator=(const OEAnalyticShapeFunc &)

      The assignment operator.

      Assignment operator.


   .. oe:method:: GetAnalyticOptions

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

         .. oe:api::

            const OEAnalyticOptions& GetAnalyticOptions() const

      .. oe:language:: python

         .. oe:api:: python

            GetAnalyticOptions() -> OEAnalyticOptions

      Returns a reference to the :ref:`OEAnalyticOptions <OEShape_OEAnalyticOptions>`
      instance as currently set for this :ref:`OEAnalyticShapeFunc <OEShape_OEAnalyticShapeFunc>`.
