VTK
vtkBond.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkBond.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
21 #ifndef vtkBond_h
22 #define vtkBond_h
23 
24 #include "vtkCommonDataModelModule.h" // For export macro
25 #include "vtkObject.h" // For macros, etc
26 #include "vtkAtom.h" // For vtkAtom
27 
28 class vtkMolecule;
29 
30 class VTKCOMMONDATAMODEL_EXPORT vtkBond
31 {
32 public:
33  void PrintSelf(ostream &os, vtkIndent indent);
34 
38  vtkIdType GetId() const;
39 
43  vtkMolecule * GetMolecule();
44 
46 
49  vtkIdType GetBeginAtomId() const;
50  vtkIdType GetEndAtomId() const;
52 
54 
58  vtkAtom GetBeginAtom();
59  vtkAtom GetEndAtom();
60  const vtkAtom GetBeginAtom() const;
61  const vtkAtom GetEndAtom() const;
63 
67  unsigned short GetOrder();
68 
75  double GetLength() const;
76 
77 protected:
78  friend class vtkMolecule;
79 
80  vtkBond(vtkMolecule *parent, vtkIdType id,
81  vtkIdType beginAtomId, vtkIdType endAtomId);
82 
87 };
88 
89 inline vtkIdType vtkBond::GetId() const
90 {
91  return this->Id;
92 }
93 
95 {
96  return this->Molecule;
97 }
98 
99 #endif
100 // VTK-HeaderTest-Exclude: vtkBond.h
vtkIdType GetId() const
Return the Id used to identify this bond in the parent molecule.
Definition: vtkBond.h:89
class describing a molecule
Definition: vtkMolecule.h:91
vtkIdType Id
Definition: vtkBond.h:84
int vtkIdType
Definition: vtkType.h:347
vtkIdType BeginAtomId
Definition: vtkBond.h:85
vtkMolecule * Molecule
Definition: vtkBond.h:83
vtkMolecule * GetMolecule()
Return the parent molecule of this bond.
Definition: vtkBond.h:94
a simple class to control print indentation
Definition: vtkIndent.h:33
friend class vtkBond
Definition: vtkMolecule.h:470
convenience proxy for vtkMolecule
Definition: vtkAtom.h:31
vtkIdType EndAtomId
Definition: vtkBond.h:86
convenience proxy for vtkMolecule
Definition: vtkBond.h:30