.. include:: ../substitutions

.. oe:namespace:: OEGraphSim

.. meta::
   :keywords: OEGetFPType

.. oe:function:: OEGetFPType

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

      .. oe:api::

         const OEFPTypeBase* OEGetFPType(const unsigned int fptype,
                                         const bool vs = false,
                                         const unsigned vsversion = 1u)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPType(fptype: int, vs: bool = False, vsVersion: int = 1) -> OEFPTypeBase

   Returns a *const* pointer of a default fingerprint type.

   *fptype*
      The type of the fingerprint. This value has to be from the
      :oe:constns:`OEGraphSim::OEFPType` namespace.

   *vs*
      If ``true`` and the fingerprint type is either :ref:`section_fingerprint_path`,
      :ref:`section_fingerprint_tree` or :ref:`section_fingerprint_circular`, then the
      atom and bond typings designed for virtual screening will be used.
      Any other cases this parameter will be ignored.

   *vsversion*
      The version for the virtual screening fingerprint. Passing a value of ``0u`` requests the
      latest version of the fingerprint from the current toolkit.  Supported values are
      ``1u`` (pre-2025.1 toolkits), and ``0u`` or  ``2u`` (post-2025.1 toolkits).

      .. note::

         The boolean argument signature for this function to request virtual screening
         fingerprints will be deprecated in favor of the explicit API
         function :oe:func:`OEGraphSim::OEGetVSFPType` in future toolkit releases.

      .. seealso::

         * :oe:constns:`OEGraphSim::OEFPAtomType` namespace
         * :oe:constns:`OEGraphSim::OEFPBondType` namespace
         * :oe:func:`OEGraphSim::OEGetVSFPType`

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

      .. oe:api::

         const OEFPTypeBase* OEGetFPType(const std::string& fptypestring)

   .. oe:language:: python

      .. oe:api:: python

         OEGetFPType(fptypestring: str) -> OEFPTypeBase

   Returns a *const* pointer of a fingerprint type of the given valid
   string representation.
   If the string representation is not valid, it will return a NULL
   pointer.


   .. seealso::

      * :oe:func:`OEGraphSim::OEIsValidFPTypeString` function
      * :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString` method
      * :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` class
      * :oe:func:`OEGraphSim::OEGetCircularFPType` function
      * :oe:func:`OEGraphSim::OEGetPathFPType` function
      * :oe:func:`OEGraphSim::OEGetTreeFPType` function
