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

.. oe:namespace:: OEBioisostere

.. meta::
   :keywords: OEFragConfReader, FragConfReader


.. _OEBioisostere_OEFragConfReader:

.. oe:class:: OEFragConfReader

   .. attention::

      |PRELIMINARY-API|

   .. oe:api::

      class OEFragConfReader

   This class defines an interface to perform fragment conformer sampling from
   provided 3D molecular structures.

   The :ref:`OEFragConfReader <OEBioisostere_OEFragConfReader>` class defines the following public methods:
    * :oe:meth:`Init<OEBioisostere::OEFragConfReader::Init>`
    * :oe:meth:`NumMols<OEBioisostere::OEFragConfReader::NumMols>`
    * :oe:meth:`ReadConformers<OEBioisostere::OEFragConfReader::ReadConformers>`

   

   .. _OEBioisostere_OEFragConfReader_Constructors:
   .. oe:method:: Constructors

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

         .. oe:api::

            OEFragConfReader()

      .. oe:language:: python

         .. oe:api:: python

            OEFragConfReader() -> OEFragConfReader

      Default constructor.


   .. _OEBioisostere_OEFragConfReader_Init:
   .. oe:method:: Init

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

         .. oe:api::

            bool Init(OEChem::oemolistream& ifs)

      .. oe:language:: python

         .. oe:api:: python

            Init(ifs: oemolistream) -> bool

      Initializes the reader with 3D molecules from which to sample fragment conformers.


   .. _OEBioisostere_OEFragConfReader_NumMols:
   .. oe:method:: NumMols

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

         .. oe:api::

            unsigned NumMols() const

      .. oe:language:: python

         .. oe:api:: python

            NumMols() -> int

      Returns the number of molecules obtained during initialization.


   .. _OEBioisostere_OEFragConfReader_ReadConformers:
   .. oe:method:: ReadConformers

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

         .. oe:api::

            bool ReadConformers(OEChem::OEMCMolBase& mol) const

      .. oe:language:: python

         .. oe:api:: python

            ReadConformers(mol: OEMol) -> bool

      Reads fragment conformers from initialized molecule structures and
      outputs conformers into the provided molecule.
