.. oe:namespace:: OEProton



.. meta::
   :keywords: OETyperMolFunction, TyperMolFunction


.. _OEProton_OETyperMolFunction:

.. oe:class:: OETyperMolFunction

   .. oe:api::


      class OETyperMolFunction : public OEMolFunctionBase

   Currently
   ``OETyperMolFunction`` and :ref:`OETautomerMolFunction <OEProton_OETautomerMolFunction>`
   are similar, however it is expected that they will diverge more
   over time.  They share the same first four arguments.  The first
   argument is the oemolstream where the enumerated molecules will be
   placed.  The second argument is a boolean indicating whether
   aromaticity should be calculated for the enumerated structure.  The
   third argument is a boolean indicating whether the enumerated
   states should only be counted (rather than actually listed).  The
   fourth argument is an unsigned int indicating the maximum number of
   states that should be enumerated for any single input molecule.

   .. oe:method:: Constructors

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

         .. oe:api::

            OETyperMolFunction(OEChem::oemolostream& ofp, bool arom,
                               bool ct = false, unsigned int max = 0)

      .. oe:language:: python

         .. oe:api:: python

            OETyperMolFunction(ofp: oemolostream, arom: bool, ct: bool = False,
                               max: int = 0) -> OETyperMolFunction

      Default and copy constructors.

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

      .. oe:api::

         OETyperMolFunction & operator=(const OETyperMolFunction &)

      Assignment operator.

   

   .. oe:method:: operator()

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

         .. oe:api::

            bool operator()(const OEChem::OEMolBase& inmol)

      .. oe:language:: python

         .. oe:api:: python

            __call__(inmol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

   .. oe:method:: CreateCopy

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

         .. oe:api::

            base_type* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMolFunctionBase

   .. oe:method:: Reset

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

         .. oe:api::

            void Reset()

      .. oe:language:: python

         .. oe:api:: python

            Reset() -> None

   This method will reset the internal counter and should be called
   before reusing an :ref:`OETyperMolFunction <OEProton_OETyperMolFunction>` instance.
