RDCatalog::CatalogEntry Class Reference

Abstract base class to be used to represent an entry in a Catalog. More...

#include <CatalogEntry.h>

Inheritance diagram for RDCatalog::CatalogEntry:

List of all members.

Public Member Functions
virtual	~CatalogEntry ()=0
void	setBitId (int bid)
	sets our bit Id
int	getBitId () const
	returns our bit Id
virtual std::string	getDescription () const =0
	returns a text description of this entry
virtual void	toStream (std::ostream &ss) const =0
	serializes (pickles) to a stream
virtual std::string	Serialize () const =0
	returns a string with a serialized (pickled) representation
virtual void	initFromStream (std::istream &ss)=0
	initializes from a stream pickle
virtual void	initFromString (const std::string &text)=0
	initializes from a string pickle

---

Detailed Description

Abstract base class to be used to represent an entry in a Catalog.

Definition at line 15 of file CatalogEntry.h.

---

Constructor & Destructor Documentation

virtual RDCatalog::CatalogEntry::~CatalogEntry

(

)

[pure virtual]

---

Member Function Documentation

void RDCatalog::CatalogEntry::setBitId

(

int

bid

)

[inline]

sets our bit Id

Definition at line 20 of file CatalogEntry.h.

Referenced by RDKit::FragCatalogEntry::FragCatalogEntry(), and RDKit::MolCatalogEntry::MolCatalogEntry().

int RDCatalog::CatalogEntry::getBitId

(

)

const [inline]

returns our bit Id

Definition at line 23 of file CatalogEntry.h.

virtual std::string RDCatalog::CatalogEntry::getDescription

(

)

const [pure virtual]

returns a text description of this entry

Implemented in RDKit::FragCatalogEntry, and RDKit::MolCatalogEntry.

virtual void RDCatalog::CatalogEntry::toStream

(

std::ostream &

ss

)

const [pure virtual]

serializes (pickles) to a stream

Implemented in RDKit::FragCatalogEntry, and RDKit::MolCatalogEntry.

virtual std::string RDCatalog::CatalogEntry::Serialize

(

)

const [pure virtual]

returns a string with a serialized (pickled) representation

Implemented in RDKit::FragCatalogEntry, and RDKit::MolCatalogEntry.

virtual void RDCatalog::CatalogEntry::initFromStream

(

std::istream &

ss

)

[pure virtual]

initializes from a stream pickle

Implemented in RDKit::FragCatalogEntry, and RDKit::MolCatalogEntry.

virtual void RDCatalog::CatalogEntry::initFromString

(

const std::string &

text

)

[pure virtual]

initializes from a string pickle

Implemented in RDKit::FragCatalogEntry, and RDKit::MolCatalogEntry.

---

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

• CatalogEntry.h

---