![]() |
RDKit
Open-source cheminformatics and machine learning.
|
#include <FilterCatalogEntry.h>
Public Member Functions | |
FilterCatalogEntry () | |
FilterCatalogEntry (const std::string &name, const FilterMatcherBase &matcher) | |
FilterCatalogEntry (const std::string &name, boost::shared_ptr< FilterMatcherBase > matcher) | |
FilterCatalogEntry (const FilterCatalogEntry &rhs) | |
~FilterCatalogEntry () override | |
bool | isValid () const |
Returns true if the Filters stored in this catalog entry are valid. | |
std::string | getDescription () const override |
Returns the description of the catalog entry. | |
void | setDescription (const std::string &description) |
Sets the description of the catalog entry. | |
Properties | |
STR_VECT | getPropList () const |
returns a list with the names of our properties | |
template<typename T > | |
void | setProp (const char *key, T val) |
sets a property value | |
template<typename T > | |
void | setProp (const std::string &key, T val) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
void | getProp (const char *key, T &res) const |
allows retrieval of a particular property value | |
template<typename T > | |
void | getProp (const std::string &key, T &res) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
T | getProp (const char *key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
T | getProp (const std::string &key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
template<typename T > | |
bool | getPropIfPresent (const char *key, T &res) const |
template<typename T > | |
bool | getPropIfPresent (const std::string &key, T &res) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
bool | hasProp (const char *key) const |
returns whether or not we have a property with name key | |
bool | hasProp (const std::string &key) const |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
void | clearProp (const char *key) |
clears the value of a property | |
void | clearProp (const std::string &key) |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. | |
Dict & | getProps () |
const Dict & | getProps () const |
void | setProps (const Dict &props) |
bool | getFilterMatches (const ROMol &mol, std::vector< FilterMatch > &matchVect) const |
Returns the matching filters for this catalog entry. | |
bool | hasFilterMatch (const ROMol &mol) const |
Returns true if the filters in this catalog entry match the molecule. | |
void | toStream (std::ostream &ss) const override |
serializes (pickles) to a stream | |
std::string | Serialize () const override |
returns a string with a serialized (pickled) representation | |
void | initFromStream (std::istream &ss) override |
initializes from a stream pickle | |
void | initFromString (const std::string &text) override |
initializes from a string pickle | |
![]() | |
virtual | ~CatalogEntry ()=0 |
void | setBitId (int bid) |
sets our bit Id | |
int | getBitId () const |
returns our bit Id | |
Definition at line 56 of file FilterCatalogEntry.h.
|
inline |
Definition at line 63 of file FilterCatalogEntry.h.
|
inline |
Definition at line 65 of file FilterCatalogEntry.h.
|
inline |
Definition at line 70 of file FilterCatalogEntry.h.
|
inline |
Definition at line 76 of file FilterCatalogEntry.h.
|
inlineoverride |
Definition at line 81 of file FilterCatalogEntry.h.
|
inline |
clears the value of a property
Definition at line 180 of file FilterCatalogEntry.h.
|
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 185 of file FilterCatalogEntry.h.
References RDKit::Dict::clearVal().
|
overridevirtual |
Returns the description of the catalog entry.
Implements RDCatalog::CatalogEntry.
|
inline |
Returns the matching filters for this catalog entry.
Definition at line 201 of file FilterCatalogEntry.h.
|
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 150 of file FilterCatalogEntry.h.
References RDKit::Dict::getVal().
|
inline |
allows retrieval of a particular property value
key | the name under which the property should be stored. If a property is already stored under this name, it will be replaced. |
res | a reference to the storage location for the value. |
Notes:
property
with name key
exists, a KeyErrorException will be thrown.boost::lexical_cast
machinery is used to attempt type conversions. If this fails, a boost::bad_lexical_cast
exception will be thrown. Definition at line 140 of file FilterCatalogEntry.h.
References RDKit::Dict::getVal().
|
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 155 of file FilterCatalogEntry.h.
References RDKit::Dict::getVal().
|
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 145 of file FilterCatalogEntry.h.
References RDKit::Dict::getVal().
|
inline |
returns whether or not we have a property
with name key
and assigns the value if we do
Definition at line 162 of file FilterCatalogEntry.h.
References RDKit::Dict::getValIfPresent().
|
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 167 of file FilterCatalogEntry.h.
References RDKit::Dict::getValIfPresent().
|
inline |
returns a list with the names of our properties
Definition at line 103 of file FilterCatalogEntry.h.
References RDKit::Dict::keys().
|
inline |
Properties usually contain the reference and source for the catalog entry.
Definition at line 191 of file FilterCatalogEntry.h.
|
inline |
Definition at line 192 of file FilterCatalogEntry.h.
|
inline |
Returns true if the filters in this catalog entry match the molecule.
Definition at line 212 of file FilterCatalogEntry.h.
|
inline |
returns whether or not we have a property
with name key
Definition at line 172 of file FilterCatalogEntry.h.
References RDKit::Dict::hasVal().
|
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 174 of file FilterCatalogEntry.h.
References RDKit::Dict::hasVal().
|
overridevirtual |
initializes from a stream pickle
Implements RDCatalog::CatalogEntry.
|
overridevirtual |
initializes from a string pickle
Implements RDCatalog::CatalogEntry.
|
inline |
Returns true if the Filters stored in this catalog entry are valid.
Definition at line 86 of file FilterCatalogEntry.h.
|
overridevirtual |
returns a string with a serialized (pickled) representation
Implements RDCatalog::CatalogEntry.
void RDKit::FilterCatalogEntry::setDescription | ( | const std::string & | description | ) |
Sets the description of the catalog entry.
|
inline |
sets a property
value
key | the name under which the property should be stored. If a property is already stored under this name, it will be replaced. |
val | the value to be stored |
Definition at line 113 of file FilterCatalogEntry.h.
|
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 119 of file FilterCatalogEntry.h.
References RDKit::Dict::setVal().
|
inline |
Definition at line 193 of file FilterCatalogEntry.h.
|
overridevirtual |
serializes (pickles) to a stream
Implements RDCatalog::CatalogEntry.