.. oe:namespace:: OEMedChem


.. meta::
   :keywords: OEMatchedPair, MatchedPair


.. _OEMedChem_OEMatchedPair:

.. oe:class:: OEMatchedPair

   .. oe:api::

      class OEMatchedPair

   This class identifies a specific matched molecular pair.

   .. oe:method:: Constructors

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

         .. oe:api::

            OEMatchedPair(const OEMatchedPair& rhs)
            OEMatchedPair(unsigned int fromIndex = 0u,
                          unsigned int toIndex = 0u,
                          const char* fromSmiles = 0, const char* toSmiles = 0)

      .. oe:language:: python

         .. oe:api:: python

            OEMatchedPair(rhs: OEMatchedPair) -> OEMatchedPair
            OEMatchedPair(fromIndex: int = 0, toIndex: int = 0,
                          fromSmiles: str = None, toSmiles: str = None) -> OEMatchedPair

      Constructs an object from the passed arguments.

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

      .. oe:api::

         OEMatchedPair &operator=(const OEMatchedPair &rhs)

      Assignment operator that copies the data of the 'rhs' :ref:`OEMatchedPair <OEMedChem_OEMatchedPair>` object.

      Assignment operator.


   .. oe:method:: AddSDData

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

         .. oe:api::

            bool AddSDData(const std::string& tag,
                           const std::string& fromValue,
                           const std::string& toValue)

      .. oe:language:: python

         .. oe:api:: python

            AddSDData(tag: str, fromValue: str, toValue: str) -> bool

      Add SD data information to the matched pair.  The tag is the field name of the SD data
      and the from and to arguments indicate the respective data for the molecular pair.

   .. oe:method:: ClearSDData

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

         .. oe:api::

            void ClearSDData()

      .. oe:language:: python

         .. oe:api:: python

            ClearSDData() -> None

      Deletes all SD data recorded for the molecular pair.

   .. oe:method:: CreateCopy

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

         .. oe:api::

            OEMatchedPair* CreateCopy() const

      .. oe:language:: python

         .. oe:api:: python

            CreateCopy() -> OEMatchedPair

   .. oe:method:: FromIndex

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

         .. oe:api::

            unsigned int FromIndex() const

      .. oe:language:: python

         .. oe:api:: python

            FromIndex() -> int

      This is the from index of the matched molecular pair.

   .. oe:method:: FromSmiles

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

         .. oe:api::

            const std::string& FromSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            FromSmiles() -> str

      This is the from SMILES string of the matched molecular pair.

   .. oe:method:: GetDataTags

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

         .. oe:api::

            OESystem::OEIterBase<const std::string>* GetDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            GetDataTags() -> Iterable[str]

      This method returns an iterator of over the SD data field tags recorded for the matched molecular pair.

   .. oe:method:: GetFromSDData

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

         .. oe:api::

            std::string GetFromSDData(const std::string& tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetFromSDData(tag: str) -> str

      This method returns SD data with the specified 'tag' for the from structure of the matched molecular pair.

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

      .. oe:api::

         bool GetSDData(const std::string &tag, std::string &fromValue,
                        std::string &toValue) const

      This method returns SD data for the specific data field requested for the matched molecular pair.
      If either of the from or to structures have no data present, an empty string is returned.

   .. oe:method:: GetToSDData

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

         .. oe:api::

            std::string GetToSDData(const std::string& tag) const

      .. oe:language:: python

         .. oe:api:: python

            GetToSDData(tag: str) -> str

      This method returns SD data with the specified 'tag' for the to structure of the matched molecular pair.

   .. oe:method:: HasSDData

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

         .. oe:api::

            bool HasSDData(const std::string& tag) const

      .. oe:language:: python

         .. oe:api:: python

            HasSDData(tag: str) -> bool

      This method returns a boolean indicating whether SD data of field name 'tag' is present for either of the from or to structures.

   .. oe:method:: NumDataTags

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

         .. oe:api::

            unsigned int NumDataTags() const

      .. oe:language:: python

         .. oe:api:: python

            NumDataTags() -> int

      This method returns the number of SD data tags present for the molecular pair.

   .. oe:method:: ToIndex

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

         .. oe:api::

            unsigned int ToIndex() const

      .. oe:language:: python

         .. oe:api:: python

            ToIndex() -> int

      This is the to index of the matched molecular pair.

   .. oe:method:: ToSmiles

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

         .. oe:api::

            const std::string& ToSmiles() const

      .. oe:language:: python

         .. oe:api:: python

            ToSmiles() -> str

      This is the to SMILES string of the matched molecular pair.
