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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBBuilder, DBBuilder


.. _OEBioisostere_OEDBBuilder:

.. oe:class:: OEDBBuilder

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBBuilder

   This class defines an interface for building a two-dimensional Brood
   fragment database.

   The :ref:`OEDBBuilder <OEBioisostere_OEDBBuilder>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OEDBBuilder::Add>`
    * :oe:meth:`AddCSV<OEBioisostere::OEDBBuilder::AddCSV>`
    * :oe:meth:`Expand<OEBioisostere::OEDBBuilder::Expand>`
    * :oe:meth:`Filter<OEBioisostere::OEDBBuilder::Filter>`
    * :oe:meth:`Generate<OEBioisostere::OEDBBuilder::Generate>`
    * :oe:meth:`GetFrag<OEBioisostere::OEDBBuilder::GetFrag>`
    * :oe:meth:`GetFragSmiles<OEBioisostere::OEDBBuilder::GetFragSmiles>`
    * :oe:meth:`GetFragSmilesCSV<OEBioisostere::OEDBBuilder::GetFragSmilesCSV>`
    * :oe:meth:`GetFrags<OEBioisostere::OEDBBuilder::GetFrags>`
    * :oe:meth:`NumFrags<OEBioisostere::OEDBBuilder::NumFrags>`
    * :oe:meth:`Screen<OEBioisostere::OEDBBuilder::Screen>`

   

   .. _OEBioisostere_OEDBBuilder_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEDBBuilder(const OEFragmentOptions& opts = OEFragmentOptions())


      .. oe:language:: python

         .. oe:api:: python

            OEDBBuilder(opts: OEFragmentOptions = OEFragmentOptions()) -> OEDBBuilder

      Default constructor.

   .. _OEBioisostere_OEDBBuilder_Add:

   .. oe:method:: Add

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

         .. oe:api::

            bool Add(OEChem::OEMCMolBase& frag)
            bool Add(OESystem::OEIter<OEChem::OEMCMolBase>& frag)
            bool Add(const std::string& smiles)
            bool Add(const std::vector<std::string>& vecSmiles)

      .. oe:language:: python

         .. oe:api:: python

            Add(frag: OEMol) -> bool
            Add(vecSmiles: OEStringVector) -> bool

      Adds the specified fragment(s) to the database. In the ``SMILES``-based
      overloads, fragment ``SMILES`` in the format obtained from
      :oe:meth:`GetFragSmiles<OEBioisostere::OEDBBuilder::GetFragSmiles>`
      are expected.

   .. _OEBioisostere_OEDBBuilder_AddCSV:

   .. oe:method:: AddCSV

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

         .. oe:api::

            bool AddCSV(const std::vector<std::string>& vecSmiles)

      .. oe:language:: python

         .. oe:api:: python

            AddCSV(vecSmiles: OEStringVector) -> bool

      Adds fragments from the specified ``CSV SMILES`` strings. ``SMILES`` as
      obtained from
      :oe:meth:`GetFragSmilesCSV<OEBioisostere::OEDBBuilder::GetFragSmilesCSV>`
      are expected.

   .. _OEBioisostere_OEDBBuilder_Expand:

   .. oe:method:: Expand

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

         .. oe:api::

            bool Expand(const OEConfGen::OEFlipperOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Expand(opts: OEFlipperOptions) -> bool

      Expands the database by stereo-enumerating currently contained fragments.

   .. _OEBioisostere_OEDBBuilder_Filter:

   .. oe:method:: Filter

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

         .. oe:api::

            bool Filter(OEMolProp::OEFilter& filter)

      .. oe:language:: python

         .. oe:api:: python

            Filter(filter: OEFilter) -> bool

      Filters currently contained database fragments.

   .. _OEBioisostere_OEDBBuilder_Generate:

   .. oe:method:: Generate

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

         .. oe:api::

            bool Generate(const OEChem::OEMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Generate(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

      Generates fragments from the specified molecule and adds the generated
      fragment(s) to the database.

   .. _OEBioisostere_OEDBBuilder_GetFrag:

   .. oe:method:: GetFrag

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

         .. oe:api::

            bool GetFrag(OEChem::OEMCMolBase& mol, const std::string& smiles) const

      .. oe:language:: python

         .. oe:api:: python

            GetFrag(mol: OEMol, smiles: str) -> bool

      Obtains the fragment defined by the specified ``SMILES`` string. Returns
      ``false`` if a fragment with the specified ``SMILES`` does not exist.
      ``SMILES`` in the format obtained from
      :oe:meth:`GetFragSmiles<OEBioisostere::OEDBBuilder::GetFragSmiles>`
      is expected.

   .. _OEBioisostere_OEDBBuilder_GetFragSmiles:

   .. oe:method:: GetFragSmiles

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

         .. oe:api::

            std::vector<std::string> GetFragSmiles() const
            bool GetFragSmiles(std::vector<std::string>&) const

      .. oe:language:: python

         .. oe:api:: python

            GetFragSmiles() -> OEStringVector

      Returns ``SMILES`` strings corresponding to the current database.

   .. _OEBioisostere_OEDBBuilder_GetFragSmilesCSV:

   .. oe:method:: GetFragSmilesCSV

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

         .. oe:api::

            std::vector<std::string> GetFragSmilesCSV() const
            bool GetFragSmilesCSV(std::vector<std::string>&) const

      .. oe:language:: python

         .. oe:api:: python

            GetFragSmilesCSV() -> OEStringVector
            GetFragSmilesCSV(vecSmiles: OEStringVector) -> bool

      Returns ``CSV SMILES`` strings corresponding to the current database.
      ``CSV SMILES`` contains fragment ``SMILES`` in a special
      comma-separated string format.

   .. _OEBioisostere_OEDBBuilder_GetFrags:

   .. oe:method:: GetFrags

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

         .. oe:api::

            OESystem::OEIterBase<OEChem::OEMCMolBase>* GetFrags() const

      .. oe:language:: python

         .. oe:api:: python

            GetFrags() -> Iterable[OEMol]

      Returns two-dimensional fragments corresponding to the current database.

   .. _OEBioisostere_OEDBBuilder_NumFrags:

   .. oe:method:: NumFrags

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

         .. oe:api::

            unsigned NumFrags() const

      .. oe:language:: python

         .. oe:api:: python

            NumFrags() -> int

      Returns the number of fragments corresponding to the current database.

   .. _OEBioisostere_OEDBBuilder_Screen:

   .. oe:method:: Screen

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

         .. oe:api::

            bool Screen(const OEDBScreenOptions& opts)

      .. oe:language:: python

         .. oe:api:: python

            Screen(opts: OEDBScreenOptions) -> bool

      Screens the fragments in the current database.
