OEMatchBase

class OEMatchBase : public OESystem::OERoleSet

The OEMatchBase class is the abstract interface for representing the equivalences or correspondences found in a substructure (or similar) match. The OEMatchBase class can represent substructure hits, maximal common subgraph fragments, tautomer equivalences, automorphisms and sequence alignments.

The following methods are publicly inherited from OERoleSet:

AddRole

GetRoles

ClearRoles

HasRole

DeleteRole

NumRoles

The following classes derive from this class:

operator bool

IsValid() -> bool

Same as the OEMatchBase.IsValid method.

Clear

Clear() -> None

Removes all atom and bond of pairs from any object derived from OEMatchBase and clears the OERoleSet.

CreateCopy

CreateCopy() -> OEMatchBase

Deep copy constructor that returns a copy of the object. The memory for the returned object derived from OEMatchBase is dynamically allocated and owned by the caller.

GetAtoms

GetAtoms() -> Iterable[OEMatchPair[OEAtomBase]]

Returns an iterator over OEMatchPairs which contain the atom to atom correspondences in the OEMatchBase object. The returned OEIterBase pointer should be assigned to an OEIter object to prevent memory leaks.

GetBonds

GetBonds() -> Iterable[OEMatchPair[OEBondBase]]

Returns an iterator over OEMatchPairs which contain the bond to bond correspondences in the OEMatchBase object. The returned OEIterBase pointer should be assigned to an OEIter object to prevent memory leaks.

GetPatternAtoms

GetPatternAtoms() -> OEAtomIter

Returns an iterator over the match-ordered atoms of the pattern molecule. The returned OEIterBase pointer should be assigned to an OEIter object to prevent memory leaks.

GetPatternBonds

GetPatternBonds() -> OEBondIter

Returns an iterator over the match-ordered bonds of the pattern molecule. The returned OEIterBase pointer should be assigned to an OEIter object to prevent memory leaks.

GetTargetAtoms

GetTargetAtoms() -> OEAtomIter

Returns an iterator over the match-ordered atoms of the target molecule. The returned OEIterBase pointer should be assigned to an OEIter object to prevent memory leaks.

GetTargetBonds

GetTargetBonds() -> OEBondIter

Returns an iterator over the match-ordered bonds of the target molecule. The returned OEIterBase pointer should be assigned to an OEIter object to prevent memory leaks.

IsValid

IsValid() -> bool

Returns if at least one atom or one bond equivalence is stored in the OEMatchBase object.

NumAtoms

NumAtoms() -> int

Returns the number of atom equivalences in a match.

NumBonds

NumBonds() -> int

Returns the number of bond equivalences in a match.