RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
RDKit::FilterMatcherBase Class Referenceabstract

#include <FilterMatcherBase.h>

Inheritance diagram for RDKit::FilterMatcherBase:
RDKit::ExclusionList RDKit::FilterHierarchyMatcher RDKit::FilterMatchOps::And RDKit::FilterMatchOps::Not RDKit::FilterMatchOps::Or RDKit::SmartsMatcher

Public Member Functions

 FilterMatcherBase (std::string name=DEFAULT_FILTERMATCHERBASE_NAME)
 
 FilterMatcherBase (const FilterMatcherBase &rhs)
 
virtual ~FilterMatcherBase ()
 
virtual bool isValid () const =0
 
virtual std::string getName () const
 
virtual bool getMatches (const ROMol &mol, std::vector< FilterMatch > &matchVect) const =0
 getMatches
 
virtual bool hasMatch (const ROMol &mol) const =0
 hasMatches
 
virtual boost::shared_ptr< FilterMatcherBaseClone () const
 
virtual boost::shared_ptr< FilterMatcherBasecopy () const =0
 

Detailed Description

Definition at line 75 of file FilterMatcherBase.h.

Constructor & Destructor Documentation

◆ FilterMatcherBase() [1/2]

RDKit::FilterMatcherBase::FilterMatcherBase ( std::string  name = DEFAULT_FILTERMATCHERBASE_NAME)
inline

Definition at line 82 of file FilterMatcherBase.h.

◆ FilterMatcherBase() [2/2]

RDKit::FilterMatcherBase::FilterMatcherBase ( const FilterMatcherBase rhs)
inline

Definition at line 86 of file FilterMatcherBase.h.

◆ ~FilterMatcherBase()

virtual RDKit::FilterMatcherBase::~FilterMatcherBase ( )
inlinevirtual

Definition at line 90 of file FilterMatcherBase.h.

Member Function Documentation

◆ Clone()

virtual boost::shared_ptr< FilterMatcherBase > RDKit::FilterMatcherBase::Clone ( ) const
inlinevirtual

Clone - deprecated Clones the current FilterMatcherBase into one that can be passed around safely.

Definition at line 121 of file FilterMatcherBase.h.

References BOOST_LOG, and rdWarningLog.

◆ copy()

virtual boost::shared_ptr< FilterMatcherBase > RDKit::FilterMatcherBase::copy ( ) const
pure virtual

◆ getMatches()

virtual bool RDKit::FilterMatcherBase::getMatches ( const ROMol mol,
std::vector< FilterMatch > &  matchVect 
) const
pure virtual

getMatches

Match the filter against a molecule

Parameters
molreadonly const molecule being searched
matchesoutput vector of atom index matches found in the molecule

Implemented in RDKit::FilterMatchOps::Not, RDKit::ExclusionList, RDKit::FilterHierarchyMatcher, RDKit::FilterMatchOps::And, RDKit::FilterMatchOps::Or, and RDKit::SmartsMatcher.

◆ getName()

virtual std::string RDKit::FilterMatcherBase::getName ( ) const
inlinevirtual

◆ hasMatch()

virtual bool RDKit::FilterMatcherBase::hasMatch ( const ROMol mol) const
pure virtual

hasMatches

Does the given molecule contain this filter pattern

Parameters
molreadonly const molecule being searched

Implemented in RDKit::FilterMatchOps::And, RDKit::FilterMatchOps::Or, RDKit::FilterMatchOps::Not, RDKit::SmartsMatcher, RDKit::ExclusionList, and RDKit::FilterHierarchyMatcher.

◆ isValid()


The documentation for this class was generated from the following file: