RDKit
Open-source cheminformatics and machine learning.
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Class Template Reference

a Query implementing ==: arguments must match a particular value (within an optional tolerance) More...

#include <EqualityQuery.h>

Inheritance diagram for Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >:
Queries::Query< MatchFuncArgType, MatchFuncArgType, false >

Public Member Functions

 EqualityQuery ()
 
 EqualityQuery (MatchFuncArgType v)
 constructs with our target value More...
 
 EqualityQuery (MatchFuncArgType v, MatchFuncArgType t)
 constructs with our target value and a tolerance More...
 
void setVal (MatchFuncArgType what)
 sets our target value More...
 
const MatchFuncArgType getVal () const
 returns our target value More...
 
void setTol (MatchFuncArgType what)
 sets our tolerance More...
 
const MatchFuncArgType getTol () const
 returns out tolerance More...
 
virtual bool Match (const DataFuncArgType what) const
 
virtual Query< MatchFuncArgType, DataFuncArgType, needsConversion > * copy () const
 returns a copy of this Query More...
 
std::string getFullDescription () const
 returns a fuller text description More...
 
- Public Member Functions inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
 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)(MatchFuncArgType))
 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 MatchFuncArgType arg) const
 returns whether or not we match the argument More...
 

Additional Inherited Members

- Public Types inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
typedef std::shared_ptr< Query< MatchFuncArgType, MatchFuncArgType, needsConversion > > CHILD_TYPE
 
typedef std::vector< CHILD_TYPECHILD_VECT
 
typedef CHILD_VECT::iterator CHILD_VECT_I
 
typedef CHILD_VECT::const_iterator CHILD_VECT_CI
 
- Public Attributes inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
bool(*)(MatchFuncArgType) getMatchFunc () const
 returns our match function: More...
 
MatchFuncArgType(*)(MatchFuncArgType) getDataFunc () const
 returns our data function: More...
 
MatchFuncArgType(* d_dataFunc )(MatchFuncArgType)
 
MatchFuncArgType(* d_dataFuncSameType )(MatchFuncArgType)
 
- Protected Member Functions inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
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 (MatchFuncArgType what, Int2Type< true >) const
 calls our dataFunc (which must be set) on what and returns the More...
 
- Protected Attributes inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
MatchFuncArgType d_val
 
MatchFuncArgType d_tol
 
std::string d_description
 
std::string d_queryType
 
CHILD_VECT d_children
 
bool df_negate
 
bool(* d_matchFunc )(MatchFuncArgType)
 
union {
   MatchFuncArgType(*   d_dataFunc )(DataFuncArgType)
 
   MatchFuncArgType(*   d_dataFuncSameType )(MatchFuncArgType)
 
}; 
 

Detailed Description

template<typename MatchFuncArgType, typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
class Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >

a Query implementing ==: arguments must match a particular value (within an optional tolerance)

Definition at line 23 of file EqualityQuery.h.

Constructor & Destructor Documentation

◆ EqualityQuery() [1/3]

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::EqualityQuery ( )
inline

◆ EqualityQuery() [2/3]

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::EqualityQuery ( MatchFuncArgType  v)
inlineexplicit

◆ EqualityQuery() [3/3]

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::EqualityQuery ( MatchFuncArgType  v,
MatchFuncArgType  t 
)
inline

Member Function Documentation

◆ copy()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
virtual Query<MatchFuncArgType, DataFuncArgType, needsConversion>* Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy ( ) const
inlinevirtual

returns a copy of this Query

Notes:

  • the caller is responsible for deleteing the result

Reimplemented from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >.

Reimplemented in Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, RDKit::HasPropWithValueQuery< TargetPtr, ExplicitBitVect >, RDKit::HasPropWithValueQuery< TargetPtr, std::string >, RDKit::HasPropWithValueQuery< TargetPtr, T >, RDKit::HasPropQuery< TargetPtr >, and RDKit::AtomRingQuery.

Definition at line 69 of file EqualityQuery.h.

References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_dataFunc, Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_description, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_description, Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_queryType, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_queryType, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_tol, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_val, Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::getNegation(), Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setDataFunc(), Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setNegation(), Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setTol(), and Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::setVal().

◆ getFullDescription()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
std::string Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription ( ) const
inlinevirtual

◆ getTol()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
const MatchFuncArgType Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getTol ( ) const
inline

returns out tolerance

Definition at line 49 of file EqualityQuery.h.

References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_tol.

◆ getVal()

template<typename MatchFuncArgType , typename DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
const MatchFuncArgType Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getVal ( ) const
inline

returns our target value

Definition at line 44 of file EqualityQuery.h.

References Queries::Query< MatchFuncArgType, MatchFuncArgType, false >::d_val.

◆ Match()

◆ setTol()

◆ setVal()


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