File: Snapshot.h

package info (click to toggle)
rdkit 201809.1%2Bdfsg-6
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 123,688 kB
  • sloc: cpp: 230,509; python: 70,501; java: 6,329; ansic: 5,427; sql: 1,899; yacc: 1,739; lex: 1,243; makefile: 445; xml: 229; fortran: 183; sh: 123; cs: 93
file content (74 lines) | stat: -rw-r--r-- 2,301 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
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
//
// Copyright (C) 2003-2016 Sereina Riniker, Paolo Tosco
//
//   @@ 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_SNAPSHOT_H__
#define __RD_SNAPSHOT_H__
#include <Geometry/point.h>
#include <boost/shared_array.hpp>

namespace RDKit {
  class Snapshot;
  class Trajectory;
  typedef std::vector<Snapshot> SnapshotVect;
}

namespace RDKit {

class RDKIT_TRAJECTORY_EXPORT Snapshot {
  friend class Trajectory;
  public:
    /*! \brief Constructor
        \param pos is a pointer to an array of (numPoints * dimension) doubles;
        numPoints and dimension must match the Trajectory which is going to
        contain this Snapshot
        \param energy is the energy associated with this set of coordinates
     */
    Snapshot(boost::shared_array<double> pos, double energy = 0.0) :
      d_trajectory(NULL),
      d_energy(energy),
      d_pos(pos) {}
    /*! \return a const pointer to the parent Trajectory
     */
    const Trajectory *trajectory() const {
      return d_trajectory;
    }
    /*! \param pointNum is the atom number whose coordinates will be retrieved
        \return the coordinates at pointNum as a Point2D object;
        requires the Trajectory dimension to be == 2
     */
    RDGeom::Point2D getPoint2D(unsigned int pointNum) const;
    /*! \param pointNum is the atom number whose coordinates will be retrieved
        \return the coordinates at pointNum as a Point3D object;
        requires the Trajectory dimension to be >= 2
     */
    RDGeom::Point3D getPoint3D(unsigned int pointNum) const;
    /*! \return the energy for this Snapshot
     */
    double getEnergy() const {
      return d_energy;
    };
    /*! \brief Sets the energy for this Snapshot
        \param energy the energy value assigned to this Snapshot
     */
    void setEnergy(double energy) {
      d_energy = energy;
    }
  private:
    // Pointer to the parent Trajectory object
    const Trajectory *d_trajectory;
    // Energy for this set of coordinates
    double d_energy;
    // shared array to Snapshot coordinates
    boost::shared_array<double> d_pos;
};

}
#endif