RDKit
Open-source cheminformatics and machine learning.
Loading...
Searching...
No Matches
Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion > Class Template Reference

a Query implementing a set: arguments must one of a set of values More...

#include <SetQuery.h>

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

Public Types

typedef std::set< MatchFuncArgType > CONTAINER_TYPE
Public Types inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
using CHILD_TYPE
using CHILD_VECT
using CHILD_VECT_I
using CHILD_VECT_CI
using MATCH_FUNC_ARG_TYPE
using DATA_FUNC_ARG_TYPE

Public Member Functions

 SetQuery ()
void insert (const MatchFuncArgType what)
 insert an entry into our set
void clear ()
 clears our set
bool Match (const DataFuncArgType what) const override
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * copy () const override
 returns a copy of this Query
CONTAINER_TYPE::const_iterator beginSet () const
CONTAINER_TYPE::const_iterator endSet () const
unsigned int size () const
std::string getFullDescription () const override
 returns a fuller text description
Public Member Functions inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
 Query ()
virtual ~Query ()
void setNegation (bool what)
 sets whether or not we are negated
bool getNegation () const
 returns whether or not we are negated
void setDescription (const std::string &descr)
 sets our text description
const std::string & getDescription () const
 returns our text description
void setTypeLabel (const std::string &typ)
 sets our type label
const std::string & getTypeLabel () const
 returns our text label.
void setMatchFunc (bool(*what)(MatchFuncArgType))
 sets our match function
void setDataFunc (MatchFuncArgType(*what)(MatchFuncArgType))
 sets our data function
void addChild (CHILD_TYPE child)
 adds a child to our list of children
CHILD_VECT_CI beginChildren () const
 returns an iterator for the beginning of our child vector
CHILD_VECT_CI endChildren () const
 returns an iterator for the end of our child vector
virtual bool Match (const MatchFuncArgType arg) const
 returns whether or not we match the argument

Protected Attributes

CONTAINER_TYPE d_set
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) 
}; 

Additional Inherited Members

Public Attributes inherited from Queries::Query< MatchFuncArgType, MatchFuncArgType, false >
bool(*)(MatchFuncArgType) getMatchFunc () const
 returns our match function:
MatchFuncArgType(*)(MatchFuncArgType) getDataFunc () const
 returns our data function:
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

Detailed Description

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

a Query implementing a set: arguments must one of a set of values

Definition at line 25 of file SetQuery.h.

Member Typedef Documentation

◆ CONTAINER_TYPE

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
typedef std::set<MatchFuncArgType> Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::CONTAINER_TYPE

Definition at line 28 of file SetQuery.h.

Constructor & Destructor Documentation

◆ SetQuery()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::SetQuery ( )
inline

Definition at line 30 of file SetQuery.h.

Member Function Documentation

◆ beginSet()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
CONTAINER_TYPE::const_iterator Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::beginSet ( ) const
inline

Definition at line 63 of file SetQuery.h.

◆ clear()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::clear ( )
inline

clears our set

Definition at line 40 of file SetQuery.h.

◆ copy()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy ( ) const
inlineoverridevirtual

returns a copy of this Query

Notes:

  • the caller is responsible for deleteing the result

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

Definition at line 48 of file SetQuery.h.

◆ endSet()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
CONTAINER_TYPE::const_iterator Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::endSet ( ) const
inline

Definition at line 66 of file SetQuery.h.

◆ getFullDescription()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
std::string Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription ( ) const
inlineoverridevirtual

returns a fuller text description

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

Definition at line 69 of file SetQuery.h.

◆ insert()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
void Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::insert ( const MatchFuncArgType what)
inline

insert an entry into our set

Definition at line 33 of file SetQuery.h.

Referenced by Queries::SetQuery< int, Atom const *, true >::copy(), and RDKit::RecursiveStructureQuery::copy().

◆ Match()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
bool Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::Match ( const DataFuncArgType what) const
inlineoverride

Definition at line 42 of file SetQuery.h.

◆ size()

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
unsigned int Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::size ( ) const
inline

Definition at line 67 of file SetQuery.h.

Member Data Documentation

◆ d_set

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
CONTAINER_TYPE Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::d_set
protected

Definition at line 84 of file SetQuery.h.

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