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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBWriter, DBWriter


.. _OEBioisostere_OEDBWriter:

.. oe:class:: OEDBWriter

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBWriter

   This class defines an interface for writing a Brood database to disk.

   The :ref:`OEDBWriter <OEBioisostere_OEDBWriter>` class defines the following public methods:
    * :oe:meth:`Finish<OEBioisostere::OEDBWriter::Finish>`
    * :oe:meth:`Init<OEBioisostere::OEDBWriter::Init>`
    * :oe:meth:`Write<OEBioisostere::OEDBWriter::Write>`

   

   .. _OEBioisostere_OEDBWriter_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEDBWriter()

      .. oe:language:: python

         .. oe:api:: python

            OEDBWriter() -> OEDBWriter

      Default constructor.


   .. _OEBioisostere_OEDBWriter_Finish:
   .. oe:method:: Finish

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

         .. oe:api::

            bool Finish()

      .. oe:language:: python

         .. oe:api:: python

            Finish() -> bool

      Closes database files and finalizes the database. This method must be
      called to produce a valid database.


   .. _OEBioisostere_OEDBWriter_Init:
   .. oe:method:: Init

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

         .. oe:api::

            bool Init(const std::string& prefix, unsigned max = 1000)

      .. oe:language:: python

         .. oe:api:: python

            Init(prefix: str, max: int = 1000) -> bool

      Initializes the database for writing. The ``prefix`` parameter specifies
      the database folder and file prefix, and ``maxBufferSize`` specifies the
      maximum in-memory buffer size before flushing to disk.


   .. _OEBioisostere_OEDBWriter_Write:
   .. oe:method:: Write

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

         .. oe:api::

            bool Write(OEChem::OEMCMolBase& mol)
            Writes the specified fragment to the database.

      .. oe:language:: python

         .. oe:api:: python

            Write(mol: OEMol) -> bool
