File: CatalogEntry.h

package info (click to toggle)
rdkit 202009.4-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 129,624 kB
  • sloc: cpp: 288,030; python: 75,571; java: 6,999; ansic: 5,481; sql: 1,968; yacc: 1,842; lex: 1,254; makefile: 572; javascript: 461; xml: 229; fortran: 183; sh: 134; cs: 93
file content (48 lines) | stat: -rw-r--r-- 1,386 bytes parent folder | download
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
//
//  Copyright (C) 2003-2006 Rational Discovery LLC
//
//  @@ 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_CATALOGENTRY_H__
#define __RD_CATALOGENTRY_H__

#include <iostream>
#include <string>

namespace RDCatalog {

//! Abstract base class to be used to represent an entry in a Catalog
class RDKIT_CATALOGS_EXPORT CatalogEntry {
 public:
  virtual ~CatalogEntry() = 0;

  //! sets our bit Id
  void setBitId(int bid) { d_bitId = bid; };

  //! returns our bit Id
  int getBitId() const { return d_bitId; };

  //! returns a text description of this entry
  virtual std::string getDescription() const = 0;

  //! serializes (pickles) to a stream
  virtual void toStream(std::ostream &ss) const = 0;
  //! returns a string with a serialized (pickled) representation
  virtual std::string Serialize() const = 0;
  //! initializes from a stream pickle
  virtual void initFromStream(std::istream &ss) = 0;
  //! initializes from a string pickle
  virtual void initFromString(const std::string &text) = 0;

 private:
  int d_bitId;  //!< our bit Id. This needs to be signed so that we can mark
                // uninitialized entries.
};
}  // namespace RDCatalog

#endif