RDKit::FragCatalogEntry Class Reference

#include <FragCatalogEntry.h>

Inheritance diagram for RDKit::FragCatalogEntry:

Public Member Functions
	FragCatalogEntry ()
	FragCatalogEntry (const ROMol *omol, const PATH_TYPE &path, const MatchVectType &aidToFid)
	FragCatalogEntry (const std::string &pickle)
	~FragCatalogEntry () override
std::string	getDescription () const override
	returns a text description of this entry
void	setDescription (const std::string &val)
void	setDescription (const FragCatParams *params)
bool	match (const FragCatalogEntry *other, double tol) const
Subgraphs::DiscrimTuple	getDiscrims () const
unsigned int	getOrder () const
const INT_INT_VECT_MAP &	getFuncGroupMap () const
std::string	getSmarts ()
template<typename T>
void	setProp (const std::string_view &key, T &val) const
void	setProp (const std::string_view &key, int val) const
void	setProp (const std::string_view &key, float val) const
void	setProp (const std::string_view &key, std::string &val) const
template<typename T>
void	getProp (const std::string_view &key, T &res) const
bool	hasProp (const std::string_view &key) const
void	clearProp (const std::string_view &key) const
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
Public Member Functions inherited from RDCatalog::CatalogEntry
virtual	~CatalogEntry ()=0
void	setBitId (int bid)
	sets our bit Id
int	getBitId () const
	returns our bit Id

Detailed Description

Definition at line 28 of file FragCatalogEntry.h.

Constructor & Destructor Documentation

FragCatalogEntry() [1/3]

RDKit::FragCatalogEntry::FragCatalogEntry ( )

inline

Definition at line 31 of file FragCatalogEntry.h.

References RDCatalog::CatalogEntry::setBitId().

Referenced by match().

FragCatalogEntry() [2/3]

RDKit::FragCatalogEntry::FragCatalogEntry	(	const ROMol *	omol,
		const PATH_TYPE &	path,
		const MatchVectType &	aidToFid )

FragCatalogEntry() [3/3]

RDKit::FragCatalogEntry::FragCatalogEntry

(

const std::string &

pickle

)

~FragCatalogEntry()

RDKit::FragCatalogEntry::~FragCatalogEntry ( )

inlineoverride

Definition at line 40 of file FragCatalogEntry.h.

Member Function Documentation

clearProp()

void RDKit::FragCatalogEntry::clearProp ( const std::string_view & key ) const

inline

Definition at line 99 of file FragCatalogEntry.h.

getDescription()

std::string RDKit::FragCatalogEntry::getDescription ( ) const

inlineoverridevirtual

returns a text description of this entry

Implements RDCatalog::CatalogEntry.

Definition at line 49 of file FragCatalogEntry.h.

getDiscrims()

Subgraphs::DiscrimTuple RDKit::FragCatalogEntry::getDiscrims

(

)

const

getFuncGroupMap()

const INT_INT_VECT_MAP & RDKit::FragCatalogEntry::getFuncGroupMap ( ) const

inline

Definition at line 64 of file FragCatalogEntry.h.

getOrder()

unsigned int RDKit::FragCatalogEntry::getOrder ( ) const

inline

Definition at line 62 of file FragCatalogEntry.h.

getProp()

template<typename T>

void RDKit::FragCatalogEntry::getProp ( const std::string_view & key, T & res ) const

inline

Definition at line 88 of file FragCatalogEntry.h.

getSmarts()

std::string RDKit::FragCatalogEntry::getSmarts ( )

inline

Definition at line 67 of file FragCatalogEntry.h.

hasProp()

bool RDKit::FragCatalogEntry::hasProp ( const std::string_view & key ) const

inline

Definition at line 92 of file FragCatalogEntry.h.

initFromStream()

void RDKit::FragCatalogEntry::initFromStream ( std::istream & ss )

overridevirtual

initializes from a stream pickle

Implements RDCatalog::CatalogEntry.

initFromString()

void RDKit::FragCatalogEntry::initFromString ( const std::string & text )

overridevirtual

initializes from a string pickle

Implements RDCatalog::CatalogEntry.

match()

bool RDKit::FragCatalogEntry::match	(	const FragCatalogEntry *	other,
		double	tol ) const

References FragCatalogEntry().

Serialize()

std::string RDKit::FragCatalogEntry::Serialize ( ) const

overridevirtual

returns a string with a serialized (pickled) representation

Implements RDCatalog::CatalogEntry.

setDescription() [1/2]

void RDKit::FragCatalogEntry::setDescription

(

const FragCatParams *

params

)

setDescription() [2/2]

void RDKit::FragCatalogEntry::setDescription ( const std::string & val )

inline

Definition at line 51 of file FragCatalogEntry.h.

setProp() [1/4]

void RDKit::FragCatalogEntry::setProp ( const std::string_view & key, float val ) const

inline

Definition at line 79 of file FragCatalogEntry.h.

setProp() [2/4]

void RDKit::FragCatalogEntry::setProp ( const std::string_view & key, int val ) const

inline

Definition at line 75 of file FragCatalogEntry.h.

setProp() [3/4]

void RDKit::FragCatalogEntry::setProp ( const std::string_view & key, std::string & val ) const

inline

Definition at line 83 of file FragCatalogEntry.h.

setProp() [4/4]

template<typename T>

void RDKit::FragCatalogEntry::setProp ( const std::string_view & key, T & val ) const

inline

Definition at line 71 of file FragCatalogEntry.h.

toStream()

void RDKit::FragCatalogEntry::toStream ( std::ostream & ss ) const

overridevirtual

serializes (pickles) to a stream

Implements RDCatalog::CatalogEntry.

---

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

• FragCatalogEntry.h