.. oe:namespace:: OEGraphSim


.. meta::
   :keywords: OEFPTypeBase, FPTypeBase


.. _OEGraphSim_OEFPTypeBase:

.. oe:class:: OEFPTypeBase

   .. oe:api::

      class OEFPTypeBase

   The :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` class is the abstract
   interface for representing :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>`
   types.

   .. note::

      When a :ref:`OEFingerPrint <OEGraphSim_OEFingerPrint>` object is initialized,
      its type is set to a type that is derived from this abstract
      base class.


   .. ################################################################
      #
      ################################################################

   .. oe:method:: Constructors

      .. oe:api::

         OEFPTypeBase(unsigned short v)


      Default constructor.


   .. ###############################################################################
      # OEFPTypeBase::GetFPType
      ###############################################################################

   .. oe:method:: GetFPType

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

         .. oe:api::

            unsigned int GetFPType() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetFPType() -> int

      Returns the type of the :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>` object
      from  the :oe:constns:`OEGraphSim::OEFPType` namespace.


   .. ###############################################################################
      # OEFPTypeBase::GetFPTypeString
      ###############################################################################

   .. oe:method:: GetFPTypeString

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

         .. oe:api::

            std::string GetFPTypeString() const = 0

      .. oe:language:: python

         .. oe:api:: python

            GetFPTypeString() -> str

      Returns a string representation of
      :ref:`OEFPTypeBase <OEGraphSim_OEFPTypeBase>`.
      This string representation encodes information about the
      fingerprinting method and the parameters being used to generate
      the fingerprint.

      .. note::

         The string returned by the :oe:meth:`OEGraphSim::OEFPTypeBase::GetFPTypeString`
         method does not include new line characters. The strings presented here
         were broken into separate lines only for better readability.

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Circular` fingerprint is the
      following:

      ::

        Circular,ver=2.0.0,size=4096,radius=0-5,atype=AtmNum|Arom|Chiral|FCharge|HCount|EqHalo,
        btype=Order

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Lingo` fingerprint is the
      following:

      ::

        Lingo,ver=2.0.0

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::MACCS166` fingerprint is the
      following:

      ::

        MACCS166,ver=2.0.0

      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Path` fingerprint is the
      following:

      ::

        Path,ver=2.0.0,size=4096,bonds=0-5,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb|EqHalo,
        btype=Order|Chiral


      The string representation of the default
      :oe:const:`OEGraphSim::OEFPType::Tree` fingerprint is the
      following:

      ::

        Tree,ver=2.0.0,size=4096,bonds=0-4,atype=AtmNum|Arom|Chiral|FCharge|HvyDeg|Hyb,
        btype=Order

      .. seealso::

         * :ref:`OEFPTypeParams <OEGraphSim_OEFPTypeParams>` class


   .. ###############################################################################
      # OEFPTypeBase::GetFPVersion
      ###############################################################################

   .. oe:method:: GetFPVersion

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

         .. oe:api::

            unsigned short GetFPVersion() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPVersion() -> short

      Returns the version number of the fingerprint.


   .. ###############################################################################
      # OEFPTypeBase::GetFPVersion
      ###############################################################################

   .. oe:method:: GetFPVersionString

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

         .. oe:api::

            std::string GetFPVersionString() const

      .. oe:language:: python

         .. oe:api:: python

            GetFPVersionString() -> str

      Returns the string format of the version of the fingerprint.
