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

.. oe:namespace:: OEBioisostere

.. _OEBioisostere_OECreateBroodQuery:

.. oe:function:: OECreateBroodQuery

   **Query Creation without Protein**

   .. _api_brood_query_no_protein:

   .. attention::

      |PRELIMINARY-API|

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

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEMatchBase& selection)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEAtomBondSet& selection)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEAtomBondSet) -> int
         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEMatchBase) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *query*

      The :ref:`OEBroodQuery <OEBioisostere_OEBroodQuery>` to be created.

   *mol*

     The input molecule from which a query is to be created by replacing a fragment
     of the molecule.  

   *selection*

      Criteria for selecting atoms and bonds of the molecule that becomes
      the fragment to be replaced.  The atoms and bonds must collectively
      become a single fragment.

   **Query Creation with Associated Protein**

   .. _api_brood_query_with_protein:

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

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEMatchBase& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEAtomBondSet& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEAtomBondSet, du: OEDesignUnit,
                            proteinMask: int,
                            passingProteinSelect: bool = False) -> int
         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEMatchBase, du: OEDesignUnit,
                            proteinMask: int,
                            passingProteinSelect: bool = False) -> int

   Creates a **BROOD** query. The function  returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *du*

      The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` corresponding to
      the protein target.

   *proteinMask*

      Mask to be applied with the :ref:`OEDesignUnit<OEBio_OEDesignUnit>`
      to determine the protein target.
   
   *passingProteinSelect*

      To create a **BROOD** query with a protein select, this boolean needs to be true.

   
   **Query Creation with Associated Protein and Protein Select**

   .. _api_brood_query_with_protein_and_protein_select:

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

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEMatchBase& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& mol,
                                     const OEChem::OEAtomBondSet& selection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEAtomBondSet, protDu: OEDesignUnit,
                            proteinMask: int, protSelectDu: OEDesignUnit,
                            proteinSelectMask: int) -> int
         OECreateBroodQuery(query: OEBroodQuery, mol: OEMol,
                            selection: OEMatchBase, protDu: OEDesignUnit,
                            proteinMask: int, protSelectDu: OEDesignUnit,
                            proteinSelectMask: int) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *protSelectDu*

      The :ref:`OEDesignUnit <OEBio_OEDesignUnit>` corresponding to
      the protein select target.

   *proteinSelectMask*

      Mask to be applied with the :ref:`OEDesignUnit<OEBio_OEDesignUnit>`
      to determine the protein select target.

   **Linker Query Creation with Two Molecules (Bridging) without Protein**

   .. _api_brood_linker_query_no_protein:

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

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEMatchBase& firstMolSelection,
                                     const OEChem::OEMatchBase& secondMolSelection)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEAtomBondSet& firstMolSelection,
                                     const OEChem::OEAtomBondSet& secondMolSelection)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEMatchBase,
                            secondMolSelection: OEMatchBase) -> int
         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEAtomBondSet,
                            secondMolSelection: OEAtomBondSet) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   *firstMol & secondMol*

     Input molecules from which a query is to be created by bridging a fragment
     between them. Molecules need to prepared in proper relative coordinates and
     should not be clashing for optimum results.

   *firstMolSelection and secondMolSelection*

      Criteria for selecting atoms and bonds of each molecule that becomes
      part of the bridge fragment to be replaced.  The atoms and bonds must collectively
      become a single fragment for each molecule.


   **Linker Query Creation with Two Molecules (Bridging) with Protein**

   .. _api_brood_linker_query_with_protein:

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

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEMatchBase& firstMolSelection,
                                     const OEChem::OEMatchBase& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEAtomBondSet& firstMolSelection,
                                     const OEChem::OEAtomBondSet& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const bool passingProteinSelect = false)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEMatchBase,
                            secondMolSelection: OEMatchBase, du: OEDesignUnit,
                            proteinMask: int,
                            passingProteinSelect: bool = False) -> int
         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEAtomBondSet,
                            secondMolSelection: OEAtomBondSet,
                            du: OEDesignUnit, proteinMask: int,
                            passingProteinSelect: bool = False) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.

   **Linker Query Creation with Two Molecules (Bridging) with Protein and Protein Select**

   .. _api_brood_linker_query_with_protein_and_protein_select:

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

      .. oe:api::

         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEMatchBase& firstMolSelection,
                                     const OEChem::OEMatchBase& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)
         unsigned OECreateBroodQuery(OEBroodQuery& query,
                                     const OEChem::OEMCMolBase& firstMol,
                                     const OEChem::OEMCMolBase& secondMol,
                                     const OEChem::OEAtomBondSet& firstMolSelection,
                                     const OEChem::OEAtomBondSet& secondMolSelection,
                                     const OEBio::OEDesignUnit& du,
                                     const unsigned proteinMask,
                                     const OEBio::OEDesignUnit& protSelectDu,
                                     const unsigned proteinSelectMask)

   .. oe:language:: python

      .. oe:api:: python

         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEMatchBase,
                            secondMolSelection: OEMatchBase,
                            protDu: OEDesignUnit, proteinMask: int,
                            protSelectDu: OEDesignUnit, proteinSelectMask: int) -> int
         OECreateBroodQuery(query: OEBroodQuery, firstMol: OEMol,
                            secondMol: OEMol, firstMolSelection: OEAtomBondSet,
                            secondMolSelection: OEAtomBondSet,
                            protDu: OEDesignUnit, proteinMask: int,
                            protSelectDu: OEDesignUnit, proteinSelectMask: int) -> int

   Creates a **BROOD** query. The function returns a status code from
   :ref:`OEBroodStatusCode <OEBioisostere_OEBroodStatusCode>`.





   
