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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEBroodDBPacket, BroodDBPacket


.. _OEBioisostere_OEBroodDBPacket:

.. oe:class:: OEBroodDBPacket

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEBroodDBPacket

   This class defines objects that hold a chunk of fragment data from a Brood
   database. A packet contains additional metadata that can be used to check
   relevance for bioisosteric replacement of a specific
   :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>`.

   The :ref:`OEBroodDBPacket <OEBioisostere_OEBroodDBPacket>` class defines the following public methods:
    * :oe:meth:`GetIdx<OEBioisostere::OEBroodDBPacket::GetIdx>`
    * :oe:meth:`GetFragCount<OEBioisostere::OEBroodDBPacket::GetFragCount>`
    * :oe:meth:`GetFrags<OEBioisostere::OEBroodDBPacket::GetFrags>`
    * :oe:meth:`IsValid<OEBioisostere::OEBroodDBPacket::IsValid>`
    * :oe:meth:`Load<OEBioisostere::OEBroodDBPacket::Load>`
    * :oe:meth:`ToRecord <OEBioisostere::OEBroodDBPacket::ToRecord>`

   

   .. _OEBioisostere_OEBroodDBPacket_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEBroodDBPacket()
            OEBroodDBPacket(const OEBroodDBPacket &)

      .. oe:language:: python

         .. oe:api:: python

            OEBroodDBPacket() -> OEBroodDBPacket
            OEBroodDBPacket(arg2: OEBroodDBPacket) -> OEBroodDBPacket

      Default and copy constructors.


   .. _OEBioisostere_OEBroodDBPacket_operator=:
   .. oe:method:: operator=
      :language: c++

      .. oe:api::

         OEBroodDBPacket &operator=(const OEBroodDBPacket &)

      Assignment operator.

   .. _OEBioisostere_OEBroodDBPacket_GetIdx:

   .. oe:method:: GetIdx

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

         .. oe:api::

            unsigned GetIdx() const

      .. oe:language:: python

         .. oe:api:: python

            GetIdx() -> int

      Returns the index corresponding to database storage.

   .. _OEBioisostere_OEBroodDBPacket_GetFragCount:

   .. oe:method:: GetFragCount

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

         .. oe:api::

            unsigned GetFragCount() const

      .. oe:language:: python

         .. oe:api:: python

            GetFragCount() -> int

      Returns the number of fragments contained in the packet.

   .. _OEBioisostere_OEBroodDBPacket_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 fragments that are contained in the packet.


   .. _OEBioisostere_OEBroodDBPacket_IsValid:

   .. oe:method:: IsValid

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

         .. oe:api::

            bool IsValid(const OEBroodDBFilter& filter)


      .. oe:language:: python

         .. oe:api:: python

            IsValid(filter: OEBroodDBFilter) -> bool

      Returns whether packet contents are relevant for the
      :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` associated with the
      :ref:`OEBroodDBFilter <OEBioisostere_OEBroodDBFilter>`.


   .. _OEBioisostere_OEBroodDBPacket_Load:


   .. oe:method:: Load

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

         .. oe:api::

            bool Load(const OEDataFlow::OERecord &)

      .. oe:language:: python

         .. oe:api:: python

            Load(arg2: OERecord) -> bool

      Loads packet contents from an :ref:`OERecord <OEDataFlow_OERecord>`.

   .. _OEBioisostere_OEBroodDBPacket_ToRecord:

   .. oe:method:: ToRecord

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

         .. oe:api::

            bool ToRecord(OEDataFlow::OERecord &) const

      .. oe:language:: python

         .. oe:api:: python

            ToRecord(arg2: OERecord) -> bool

      Saves packet contents into an :ref:`OERecord <OEDataFlow_OERecord>`.
