RDKit
Open-source cheminformatics and machine learning.
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, DataFuncArgType, needsConversion >

Public Types

typedef std::set< MatchFuncArgType > CONTAINER_TYPE
 
- Public Types inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
typedef boost::shared_ptr< Query< MatchFuncArgType, DataFuncArgType, 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 Member Functions

 SetQuery ()
 
void insert (const MatchFuncArgType what)
 insert an entry into our set More...
 
void clear ()
 clears our set More...
 
bool Match (const DataFuncArgType what) const
 returns whether or not we match the argument More...
 
Query< MatchFuncArgType, DataFuncArgType, needsConversion > * copy () const
 returns a copy of this Query More...
 
CONTAINER_TYPE::const_iterator beginSet () const
 
CONTAINER_TYPE::const_iterator endSet () const
 
unsigned int size () const
 
std::string getFullDescription () const
 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)
 
const std::string & getDescription () const
 returns our text description 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...
 

Protected Attributes

CONTAINER_TYPE d_set
 
- Protected Attributes inherited from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >
std::string d_description
 
CHILD_VECT d_children
 
bool df_negate
 
bool(* d_matchFunc )(MatchFuncArgType)
 
MatchFuncArgType(* d_dataFunc )(DataFuncArgType)
 

Additional Inherited Members

- 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
 calls our dataFunc (which must be set) on what and returns the More...
 

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 24 of file SetQuery.h.

Member Typedef Documentation

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

Definition at line 27 of file SetQuery.h.

Constructor & Destructor Documentation

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

Definition at line 29 of file SetQuery.h.

Member Function Documentation

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

Definition at line 58 of file SetQuery.h.

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

clears our set

Definition at line 37 of file SetQuery.h.

template<class MatchFuncArgType, class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>
Query<MatchFuncArgType, DataFuncArgType, needsConversion>* Queries::SetQuery< 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, DataFuncArgType, needsConversion >.

Definition at line 45 of file SetQuery.h.

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

Definition at line 61 of file SetQuery.h.

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

returns a fuller text description

Reimplemented from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >.

Definition at line 66 of file SetQuery.h.

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 32 of file SetQuery.h.

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

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

returns whether or not we match the argument

Reimplemented from Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >.

Definition at line 39 of file SetQuery.h.

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

Definition at line 64 of file SetQuery.h.

Member Data Documentation


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