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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEDBBuffer, DBBuffer


.. _OEBioisostere_OEDBBuffer:

.. oe:class:: OEDBBuffer

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEDBBuffer

   This class defines objects representing a Brood database held in memory.
   This is suitable for generating a database from a small set of molecules,
   to be used on-the-fly, without storing it on disk.

   The :ref:`OEDBBuffer <OEBioisostere_OEDBBuffer>` class defines the following public methods:
    * :oe:meth:`Add<OEBioisostere::OEDBBuffer::Add>`
    * :oe:meth:`Finalize<OEBioisostere::OEDBBuffer::Finalize>`
    * :oe:meth:`GetPackets<OEBioisostere::OEDBBuffer::GetPackets>`

   

   .. _OEBioisostere_OEDBBuffer_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEDBBuffer()

      .. oe:language:: python

         .. oe:api:: python

            OEDBBuffer() -> OEDBBuffer

      Default constructor.


   .. _OEBioisostere_OEDBBuffer_Add:
   .. oe:method:: Add

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

         .. oe:api::

            bool Add(OEChem::OEMCMolBase& mol)

      .. oe:language:: python

         .. oe:api:: python

            Add(mol: OEMol) -> bool

      Adds the specified fragment into the database.


   .. _OEBioisostere_OEDBBuffer_Finalize:
   .. oe:method:: Finalize

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

         .. oe:api::

            bool Finalize()

      .. oe:language:: python

         .. oe:api:: python

            Finalize() -> bool

      Finalizes the database.  This method must be called before packets can be
      retrieved from the database.


   .. _OEBioisostere_OEDBBuffer_GetPackets:
   .. oe:method:: GetPackets

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

         .. oe:api::

            const std::vector<OEBroodDBPacket>& GetPackets() const

      .. oe:language:: python

         .. oe:api:: python

            GetPackets() -> OEBroodDBPacketVector

      Returns the data packets from the database.


