1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
|
//
// Copyright (C) 2001-2022 Greg Landrum and other RDKit contributors
//
// @@ All Rights Reserved @@
// This file is part of the RDKit.
// The contents are covered by the terms of the BSD license
// which is included in the file license.txt, found at the root
// of the RDKit source tree.
//
#include <RDGeneral/export.h>
#ifndef _RD_QUERYBOND_H
#define _RD_QUERYBOND_H
#include <Query/QueryObjects.h>
#include "Bond.h"
#include "QueryOps.h"
namespace RDKit {
//! Class for storing Bond queries
/*!
QueryBond objects are derived from Bond objects, so they can be
added to molecules and the like, but they have much fancier
querying capabilities.
*/
class RDKIT_GRAPHMOL_EXPORT QueryBond : public Bond {
public:
typedef Queries::Query<int, Bond const *, true> QUERYBOND_QUERY;
QueryBond() : Bond() {}
//! initialize with a particular bond order
explicit QueryBond(BondType bT);
//! initialize from a bond
explicit QueryBond(const Bond &other)
: Bond(other), dp_query(makeBondOrderEqualsQuery(other.getBondType())) {}
QueryBond(const QueryBond &other) : Bond(other) {
if (other.dp_query) {
dp_query = other.dp_query->copy();
} else {
dp_query = nullptr;
}
}
QueryBond(QueryBond &&other) noexcept : Bond(std::move(other)) {
dp_query = std::move(other.dp_query);
}
QueryBond &operator=(QueryBond &&other) noexcept {
if (this == &other) {
return *this;
}
QueryBond::operator=(std::move(other));
dp_query = std::move(other.dp_query);
return *this;
}
~QueryBond() override;
//! returns a copy of this query, owned by the caller
Bond *copy() const override;
QueryBond &operator=(const QueryBond &other);
//! sets the BondType of this query:
void setBondType(BondType bT);
//! sets the BondDir of this query:
void setBondDir(BondDir bD);
//! returns true if we match Bond \c what
bool Match(Bond const *what) const override;
//! returns true if our query details match those of QueryBond \c what
bool QueryMatch(QueryBond const *what) const;
// This method can be used to distinguish query bonds from standard bonds
bool hasQuery() const override { return dp_query != nullptr; }
//! returns our current query
QUERYBOND_QUERY *getQuery() const override { return dp_query; }
//! replaces our current query with the value passed in
void setQuery(QUERYBOND_QUERY *what) override {
// free up any existing query (Issue255):
delete dp_query;
dp_query = what;
}
//! expands our current query
/*!
\param what the Queries::Query to be added. The ownership of
the query is passed to the current object, where it
might be deleted, so that the pointer should not be
used again in the calling code.
\param how the operator to be used in the expansion
\param maintainOrder (optional) flags whether the relative order of
the queries needs to be maintained, if this is
false, the order is reversed
<b>Notes:</b>
- \c what should probably be constructed using one of the functions
defined in QueryOps.h
- the \c maintainOrder option can be useful because the combination
operators short circuit when possible.
*/
void expandQuery(QUERYBOND_QUERY *what,
Queries::CompositeQueryType how = Queries::COMPOSITE_AND,
bool maintainOrder = true) override;
//! returns our contribution to the explicit valence of an Atom
/*!
<b>Notes:</b>
- requires an owning molecule
*/
double getValenceContrib(const Atom *at) const override;
protected:
QUERYBOND_QUERY *dp_query{nullptr};
};
namespace detail {
inline std::string qhelper(const Bond::QUERYBOND_QUERY *q, unsigned int depth) {
std::string res;
if (q) {
for (unsigned int i = 0; i < depth; ++i) {
res += " ";
}
res += q->getFullDescription() + "\n";
for (const auto &child :
boost::make_iterator_range(q->beginChildren(), q->endChildren())) {
res += qhelper(child.get(), depth + 1);
}
}
return res;
}
} // namespace detail
inline std::string describeQuery(const Bond *bond) {
PRECONDITION(bond, "bad bond");
std::string res = "";
if (bond->hasQuery()) {
res = detail::qhelper(bond->getQuery(), 0);
}
return res;
}
}; // namespace RDKit
#endif
|
