RDKit
Open-source cheminformatics and machine learning.
RDKit::AtomRingQuery Class Reference

#include <QueryOps.h>

Inheritance diagram for RDKit::AtomRingQuery:
Queries::EqualityQuery< int, ConstAtomPtr, true > Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >

Public Member Functions

 AtomRingQuery ()
 
 AtomRingQuery (int v)
 
bool Match (const ConstAtomPtr what) const override
 
Queries::Query< int, ConstAtomPtr, true > * copy () const override
 returns a copy of this query More...
 
- Public Member Functions inherited from Queries::EqualityQuery< int, ConstAtomPtr, true >
 EqualityQuery ()
 
 EqualityQuery (int v)
 constructs with our target value More...
 
 EqualityQuery (int v, int t)
 constructs with our target value and a tolerance More...
 
void setVal (int what)
 sets our target value More...
 
const int getVal () const
 returns our target value More...
 
void setTol (int what)
 sets our tolerance More...
 
const int getTol () const
 returns out tolerance More...
 
bool Match (const ConstAtomPtr what) const override
 
Query< int, ConstAtomPtr, needsConversion > * copy () const override
 returns a copy of this Query More...
 
std::string getFullDescription () const override
 returns a fuller text description More...
 
- Public Member Functions inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
 Query ()
 
virtual ~Query ()
 
void setNegation (bool what)
 sets whether or not we are negated More...
 
bool getNegation () const
 returns whether or not we are negated More...
 
void setDescription (const std::string &descr)
 sets our text description More...
 
void setDescription (const char *descr)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
const std::string & getDescription () const
 returns our text description More...
 
void setTypeLabel (const std::string &typ)
 sets our type label More...
 
void setTypeLabel (const char *typ)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. More...
 
const std::string & getTypeLabel () const
 returns our text label. More...
 
void setMatchFunc (bool(*what)(MatchFuncArgType))
 sets our match function More...
 
void setDataFunc (MatchFuncArgType(*what)(DataFuncArgType))
 sets our data function More...
 
void addChild (CHILD_TYPE child)
 adds a child to our list of children More...
 
CHILD_VECT_CI beginChildren () const
 returns an iterator for the beginning of our child vector More...
 
CHILD_VECT_CI endChildren () const
 returns an iterator for the end of our child vector More...
 
virtual bool Match (const DataFuncArgType arg) const
 returns whether or not we match the argument More...
 

Additional Inherited Members

- Public Types inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
using CHILD_TYPE = std::shared_ptr< Query< MatchFuncArgType, DataFuncArgType, needsConversion > >
 
using CHILD_VECT = std::vector< CHILD_TYPE >
 
using CHILD_VECT_I = typename CHILD_VECT::iterator
 
using CHILD_VECT_CI = typename CHILD_VECT::const_iterator
 
using MATCH_FUNC_ARG_TYPE = MatchFuncArgType
 
using DATA_FUNC_ARG_TYPE = DataFuncArgType
 
- Public Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
bool(*)(MatchFuncArgType) getMatchFunc () const
 returns our match function: More...
 
MatchFuncArgType(*)(DataFuncArgType) getDataFunc () const
 returns our data function: More...
 
- Protected Member Functions inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
MatchFuncArgType TypeConvert (MatchFuncArgType what, Int2Type< false >) const
 calls our dataFunc (if it's set) on what and returns the result, otherwise returns what More...
 
MatchFuncArgType TypeConvert (DataFuncArgType what, Int2Type< true >) const
 
- Protected Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
MatchFuncArgType d_val = 0
 
MatchFuncArgType d_tol = 0
 
std::string d_description = ""
 
std::string d_queryType = ""
 
CHILD_VECT d_children
 
bool df_negate {false}
 
bool(* d_matchFunc )(MatchFuncArgType)
 
union {
   MatchFuncArgType(*   d_dataFunc )(DataFuncArgType)
 
   MatchFuncArgType(*   d_dataFuncSameType )(MatchFuncArgType)
 
}; 
 

Detailed Description

Definition at line 701 of file QueryOps.h.

Constructor & Destructor Documentation

◆ AtomRingQuery() [1/2]

RDKit::AtomRingQuery::AtomRingQuery ( )
inline

Definition at line 704 of file QueryOps.h.

References RDKit::queryAtomRingMembership().

◆ AtomRingQuery() [2/2]

RDKit::AtomRingQuery::AtomRingQuery ( int  v)
inlineexplicit

Definition at line 709 of file QueryOps.h.

References RDKit::queryAtomRingMembership().

Member Function Documentation

◆ copy()

◆ Match()

bool RDKit::AtomRingQuery::Match ( const ConstAtomPtr  what) const
inlineoverride

Definition at line 716 of file QueryOps.h.

References Queries::queryCmp().


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