RDKit
Open-source cheminformatics and machine learning.
RDCatalog::CatalogEntry Class Referenceabstract

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

#include <CatalogEntry.h>

Inheritance diagram for RDCatalog::CatalogEntry:
RDKit::FilterCatalogEntry RDKit::FragCatalogEntry RDKit::MolCatalogEntry

Public Member Functions

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

Detailed Description

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

Definition at line 19 of file CatalogEntry.h.

Constructor & Destructor Documentation

virtual RDCatalog::CatalogEntry::~CatalogEntry ( )
pure virtual

Member Function Documentation

int RDCatalog::CatalogEntry::getBitId ( ) const
inline

returns our bit Id

Definition at line 27 of file CatalogEntry.h.

References getDescription(), initFromStream(), initFromString(), Serialize(), and toStream().

virtual std::string RDCatalog::CatalogEntry::getDescription ( ) const
pure virtual

returns a text description of this entry

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

Referenced by getBitId().

virtual void RDCatalog::CatalogEntry::initFromStream ( std::istream &  ss)
pure virtual

initializes from a stream pickle

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

Referenced by getBitId().

virtual void RDCatalog::CatalogEntry::initFromString ( const std::string &  text)
pure virtual

initializes from a string pickle

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

Referenced by getBitId().

virtual std::string RDCatalog::CatalogEntry::Serialize ( ) const
pure virtual

returns a string with a serialized (pickled) representation

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

Referenced by getBitId().

void RDCatalog::CatalogEntry::setBitId ( int  bid)
inline

sets our bit Id

Definition at line 24 of file CatalogEntry.h.

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

virtual void RDCatalog::CatalogEntry::toStream ( std::ostream &  ss) const
pure virtual

serializes (pickles) to a stream

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

Referenced by getBitId().


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