Base class for all queries. More...

#include <Query.h>

Public Types
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 Member Functions
	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...

virtual std::string	getFullDescription () const
	returns a fuller 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...

virtual Query< MatchFuncArgType, DataFuncArgType, needsConversion > *	copy () const
	returns a copy of this Query More...

Public Attributes
bool(*)(MatchFuncArgType)	getMatchFunc () const
	returns our match function: More...

MatchFuncArgType(*)(DataFuncArgType)	getDataFunc () const
	returns our data function: More...

Protected Member Functions
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
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

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

Base class for all queries.

Query objects have one or two functions associated with them:

bool matchFunc(MatchFuncArgType other) returns true or false to indicate whether this query matches other. This is mandatory.
MatchFuncArgType dataFunc(DataFuncArgType other) converts the argument other from DataFuncArgType to MatchFuncArgType. This is optional if DataFuncArgType is the same as (or implicitly convertible to) MatchFuncArgType.

Definition at line 45 of file Query.h.

Member Typedef Documentation

◆ CHILD_TYPE

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

using Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::CHILD_TYPE = std::shared_ptr< Query<MatchFuncArgType, DataFuncArgType, needsConversion> >

Definition at line 47 of file Query.h.

◆ CHILD_VECT

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

using Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::CHILD_VECT = std::vector<CHILD_TYPE>

Definition at line 49 of file Query.h.

◆ CHILD_VECT_CI

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

using Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::CHILD_VECT_CI = typename CHILD_VECT::const_iterator

Definition at line 51 of file Query.h.

◆ CHILD_VECT_I

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

using Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::CHILD_VECT_I = typename CHILD_VECT::iterator

Definition at line 50 of file Query.h.

◆ DATA_FUNC_ARG_TYPE

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

using Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::DATA_FUNC_ARG_TYPE = DataFuncArgType

Definition at line 53 of file Query.h.

◆ MATCH_FUNC_ARG_TYPE

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

using Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::MATCH_FUNC_ARG_TYPE = MatchFuncArgType

Definition at line 52 of file Query.h.

Constructor & Destructor Documentation

◆ Query()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::Query ( )

inline

Definition at line 55 of file Query.h.

◆ ~Query()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

virtual Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::~Query ( )

inlinevirtual

Definition at line 56 of file Query.h.

Member Function Documentation

◆ addChild()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::addChild ( CHILD_TYPE child )

inline

adds a child to our list of children

Definition at line 103 of file Query.h.

Referenced by Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::AndQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::OrQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), and Queries::XOrQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

◆ beginChildren()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

CHILD_VECT_CI Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::beginChildren ( ) const

inline

returns an iterator for the beginning of our child vector

Definition at line 105 of file Query.h.

Referenced by RDKit::detail::qhelper().

◆ copy()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

virtual Query< MatchFuncArgType, DataFuncArgType, needsConversion > * Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy ( ) const

inlinevirtual

returns a copy of this Query

Notes:

the caller is responsible for deleteing the result

Definition at line 131 of file Query.h.

Referenced by RDKit::QueryAtom::operator=(), RDKit::QueryAtom::QueryAtom(), and RDKit::QueryBond::QueryBond().

◆ endChildren()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

CHILD_VECT_CI Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::endChildren ( ) const

inline

returns an iterator for the end of our child vector

Definition at line 107 of file Query.h.

Referenced by RDKit::detail::qhelper().

◆ getDescription()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

const std::string & Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::getDescription ( ) const

inline

returns our text description

Definition at line 70 of file Query.h.

◆ getFullDescription()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

virtual std::string Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::getFullDescription ( ) const

inlinevirtual

returns a fuller text description

Reimplemented in Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::EqualityQuery< MatchFuncArgType, MatchFuncArgType, false >, Queries::EqualityQuery< int, ConstAtomPtr, true >, Queries::EqualityQuery< int, TargetPtr, true >, Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >, and Queries::SetQuery< int, Atom const *, true >.

Definition at line 72 of file Query.h.

Referenced by RDKit::detail::qhelper().

◆ getNegation()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

bool Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::getNegation ( ) const

inline

returns whether or not we are negated

Definition at line 61 of file Query.h.

◆ getTypeLabel()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

const std::string & Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::getTypeLabel ( ) const

inline

returns our text label.

Definition at line 85 of file Query.h.

◆ Match()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

virtual bool Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::Match ( const DataFuncArgType arg ) const

inlinevirtual

returns whether or not we match the argument

Reimplemented in Queries::SetQuery< int, Atom const *, true >, Queries::EqualityQuery< int, ConstAtomPtr, true >, Queries::EqualityQuery< MatchFuncArgType, MatchFuncArgType, false >, RDKit::HasPropQuery< TargetPtr >, RDKit::HasPropWithValueQuery< TargetPtr, T >, RDKit::HasPropWithValueQuery< TargetPtr, std::string >, RDKit::HasPropWithValueQuery< TargetPtr, ExplicitBitVect >, and Queries::EqualityQuery< int, TargetPtr, true >.

Definition at line 110 of file Query.h.

◆ setDataFunc()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setDataFunc ( MatchFuncArgType(*)(DataFuncArgType) what )

inline

sets our data function

Definition at line 94 of file Query.h.

Referenced by Queries::EqualityQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::GreaterEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::GreaterQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::LessEqualQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::LessQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::RangeQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), Queries::SetQuery< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), and RDKit::makeAtomRangeQuery().

◆ setDescription() [1/2]

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setDescription ( const char * descr )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 66 of file Query.h.

◆ setDescription() [2/2]

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setDescription ( const std::string & descr )

inline

sets our text description

Definition at line 64 of file Query.h.

Referenced by RDKit::makeAtomRangeQuery().

◆ setMatchFunc()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setMatchFunc ( bool(*)(MatchFuncArgType) what )

inline

sets our match function

Definition at line 88 of file Query.h.

◆ setNegation()

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setNegation ( bool what )

inline

sets whether or not we are negated

Definition at line 59 of file Query.h.

◆ setTypeLabel() [1/2]

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setTypeLabel ( const char * typ )

inline

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

Definition at line 83 of file Query.h.

◆ setTypeLabel() [2/2]

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

void Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::setTypeLabel ( const std::string & typ )

inline

sets our type label

Definition at line 81 of file Query.h.

◆ TypeConvert() [1/2]

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::TypeConvert	(	DataFuncArgType	what,
		Int2Type< true >
	)		const

inlineprotected

calls our dataFunc (which must be set) on what and returns the result

Definition at line 182 of file Query.h.

References PRECONDITION.

◆ TypeConvert() [2/2]

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::TypeConvert	(	MatchFuncArgType	what,
		Int2Type< false >
	)		const

inlineprotected

calls our dataFunc (if it's set) on what and returns the result, otherwise returns what

Definition at line 169 of file Query.h.

Member Data Documentation

◆

union { ... } Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::@8

◆ d_children

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

CHILD_VECT Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_children

protected

Definition at line 154 of file Query.h.

◆ d_dataFunc

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType(* Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_dataFunc) (DataFuncArgType)

Definition at line 164 of file Query.h.

Referenced by Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy(), and RDKit::AtomRingQuery::copy().

◆ d_dataFuncSameType

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType(* Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_dataFuncSameType) (MatchFuncArgType)

Definition at line 165 of file Query.h.

◆ d_description

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

std::string Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_description = ""

protected

Definition at line 152 of file Query.h.

◆ d_matchFunc

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

bool(* Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_matchFunc) (MatchFuncArgType)

protected

Definition at line 156 of file Query.h.

Referenced by Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

◆ d_queryType

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

std::string Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_queryType = ""

protected

Definition at line 153 of file Query.h.

◆ d_tol

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_tol = 0

protected

Definition at line 151 of file Query.h.

Referenced by Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

◆ d_val

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::d_val = 0

protected

Definition at line 150 of file Query.h.

Referenced by Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

◆ df_negate

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

bool Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::df_negate {false}

protected

Definition at line 155 of file Query.h.

Referenced by Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::copy().

◆ getDataFunc

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

MatchFuncArgType(*)(DataFuncArgType) Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::getDataFunc() const

inline

returns our data function:

Definition at line 98 of file Query.h.

◆ getMatchFunc

template<class MatchFuncArgType , class DataFuncArgType = MatchFuncArgType, bool needsConversion = false>

bool(*)(MatchFuncArgType) Queries::Query< MatchFuncArgType, DataFuncArgType, needsConversion >::getMatchFunc() const

inline

returns our match function:

Definition at line 92 of file Query.h.

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

Query.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CHILD_TYPE

◆ CHILD_VECT

◆ CHILD_VECT_CI

◆ CHILD_VECT_I

◆ DATA_FUNC_ARG_TYPE

◆ MATCH_FUNC_ARG_TYPE

Constructor & Destructor Documentation

◆ Query()

◆ ~Query()

Member Function Documentation

◆ addChild()

◆ beginChildren()

◆ copy()

◆ endChildren()

◆ getDescription()

◆ getFullDescription()

◆ getNegation()

◆ getTypeLabel()

◆ Match()

◆ setDataFunc()

◆ setDescription() [1/2]

◆ setDescription() [2/2]

◆ setMatchFunc()

◆ setNegation()

◆ setTypeLabel() [1/2]

◆ setTypeLabel() [2/2]

◆ TypeConvert() [1/2]

◆ TypeConvert() [2/2]

Member Data Documentation

◆

◆ d_children

◆ d_dataFunc

◆ d_dataFuncSameType

◆ d_description

◆ d_matchFunc

◆ d_queryType

◆ d_tol

◆ d_val

◆ df_negate

◆ getDataFunc

◆ getMatchFunc