RDKit
Open-source cheminformatics and machine learning.
Grid3D.h
Go to the documentation of this file.
1 //
2 // Copyright (C) 2005-2006 Rational Discovery LLC
3 //
4 // @@ All Rights Reserved @@
5 // This file is part of the RDKit.
6 // The contents are covered by the terms of the BSD license
7 // which is included in the file license.txt, found at the root
8 // of the RDKit source tree.
9 //
10 #include <RDGeneral/export.h>
11 #ifndef _GRID3D_H_20050124_1113
12 #define _GRID3D_H_20050124_1113
13 #include <exception>
14 #include <string>
15 
16 namespace RDKit {
17 class DiscreteValueVect;
18 }
19 namespace RDGeom {
20 class Point3D;
21 
22 class RDKIT_RDGEOMETRYLIB_EXPORT GridException : public std::exception {
23  public:
24  //! construct with an error message
25  GridException(const char *msg) : _msg(msg){};
26  //! construct with an error message
27  GridException(const std::string &msg) : _msg(msg){};
28  //! get the error message
29  const char *what() const noexcept override { return _msg.c_str(); };
30  const char *message() const noexcept { return what(); };
31  ~GridException() noexcept {};
32 
33  private:
34  std::string _msg;
35 };
36 
37 //! Virtual base class for a grid object
39  public:
40  virtual ~Grid3D(){};
41  virtual int getGridPointIndex(const Point3D &point) const = 0;
42  virtual int getVal(const Point3D &point) const = 0;
43  virtual void setVal(const Point3D &point, unsigned int val) = 0;
44 
45  virtual Point3D getGridPointLoc(unsigned int pointId) const = 0;
46  virtual unsigned int getVal(unsigned int pointId) const = 0;
47  virtual void setVal(unsigned int pointId, unsigned int val) = 0;
48 
49  virtual unsigned int getSize() const = 0;
50 
51  virtual const RDKit::DiscreteValueVect *getOccupancyVect() const = 0;
52 };
53 } // namespace RDGeom
54 
55 #endif
RDGeom::Grid3D::~Grid3D
virtual ~Grid3D()
Definition: Grid3D.h:40
RDGeom::GridException::message
const char * message() const noexcept
Definition: Grid3D.h:30
RDGeom::GridException
Definition: Grid3D.h:22
RDGeom
Definition: TorsionAngleM6.h:20
RDGeom::Grid3D::getVal
virtual unsigned int getVal(unsigned int pointId) const =0
RDGeom::Point3D
Definition: point.h:46
RDGeom::Grid3D::getVal
virtual int getVal(const Point3D &point) const =0
RDGeom::GridException::GridException
GridException(const std::string &msg)
construct with an error message
Definition: Grid3D.h:27
RDGeom::Grid3D::getOccupancyVect
virtual const RDKit::DiscreteValueVect * getOccupancyVect() const =0
RDGeom::Grid3D::setVal
virtual void setVal(const Point3D &point, unsigned int val)=0
RDKIT_RDGEOMETRYLIB_EXPORT
#define RDKIT_RDGEOMETRYLIB_EXPORT
Definition: export.h:515
RDGeom::Grid3D::getSize
virtual unsigned int getSize() const =0
RDGeom::GridException::~GridException
~GridException() noexcept
Definition: Grid3D.h:31
RDKit::DiscreteValueVect
a class for efficiently storing vectors of discrete values
Definition: DiscreteValueVect.h:24
RDGeom::Grid3D
Virtual base class for a grid object.
Definition: Grid3D.h:38
RDKit
Std stuff.
Definition: Atom.h:30
RDGeom::Grid3D::getGridPointIndex
virtual int getGridPointIndex(const Point3D &point) const =0
RDGeom::Grid3D::setVal
virtual void setVal(unsigned int pointId, unsigned int val)=0
RDGeom::GridException::what
const char * what() const noexcept override
get the error message
Definition: Grid3D.h:29
RDGeom::Grid3D::getGridPointLoc
virtual Point3D getGridPointLoc(unsigned int pointId) const =0
RDGeom::GridException::GridException
GridException(const char *msg)
construct with an error message
Definition: Grid3D.h:25
export.h