vtkBond Class Reference

convenience proxy for vtkMolecule More...

#include <vtkBond.h>

Collaboration diagram for vtkBond:

List of all members.

Public Member Functions
	~vtkBond ()
void	PrintSelf (ostream &os, vtkIndent indent)
vtkIdType	GetId () const
vtkMolecule *	GetMolecule ()
unsigned short	GetOrder ()
double	GetLength () const
vtkIdType	GetBeginAtomId () const
vtkIdType	GetEndAtomId () const
vtkAtom	GetBeginAtom ()
vtkAtom	GetEndAtom ()
const vtkAtom	GetBeginAtom () const
const vtkAtom	GetEndAtom () const
Protected Member Functions
	vtkBond (vtkMolecule *parent, vtkIdType id, vtkIdType beginAtomId, vtkIdType endAtomId)
Protected Attributes
vtkMolecule *	Molecule
vtkIdType	Id
vtkIdType	BeginAtomId
vtkIdType	EndAtomId
Friends
class	vtkMolecule

---

Detailed Description

convenience proxy for vtkMolecule

Tests:

vtkBond (Tests)

Definition at line 32 of file vtkBond.h.

---

Constructor & Destructor Documentation

vtkBond::~vtkBond

(

)

vtkBond::vtkBond	(	vtkMolecule *	parent,
		vtkIdType	id,
		vtkIdType	beginAtomId,
		vtkIdType	endAtomId
	)		[protected]

---

Member Function Documentation

void vtkBond::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

vtkIdType vtkBond::GetId

(

)

const [inline]

Return the Id used to identify this bond in the parent molecule.

Definition at line 79 of file vtkBond.h.

vtkMolecule * vtkBond::GetMolecule

(

)

[inline]

Return the parent molecule of this bond.

Definition at line 84 of file vtkBond.h.

vtkIdType vtkBond::GetBeginAtomId

(

)

const

Get the starting / ending atom ids for this bond.

vtkIdType vtkBond::GetEndAtomId

(

)

const

Get the starting / ending atom ids for this bond.

vtkAtom vtkBond::GetBeginAtom

(

)

Get a vtkAtom object that refers to the starting / ending atom for this bond.

vtkAtom vtkBond::GetEndAtom

(

)

Get a vtkAtom object that refers to the starting / ending atom for this bond.

const vtkAtom vtkBond::GetBeginAtom

(

)

const

Get a vtkAtom object that refers to the starting / ending atom for this bond.

const vtkAtom vtkBond::GetEndAtom

(

)

const

Get a vtkAtom object that refers to the starting / ending atom for this bond.

unsigned short vtkBond::GetOrder

(

)

Get the bond order for this bond.

double vtkBond::GetLength

(

)

const

Get the distance between the bonded atoms.

Note:

This function is faster than vtkMolecule::GetBondLength and should be used when possible.

---

Friends And Related Function Documentation

friend class vtkMolecule [friend]

Definition at line 68 of file vtkBond.h.

---

Member Data Documentation

vtkMolecule* vtkBond::Molecule [protected]

Definition at line 73 of file vtkBond.h.

vtkIdType vtkBond::Id [protected]

Definition at line 74 of file vtkBond.h.

vtkIdType vtkBond::BeginAtomId [protected]

Definition at line 75 of file vtkBond.h.

vtkIdType vtkBond::EndAtomId [protected]

Definition at line 76 of file vtkBond.h.

---

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

• dox/Common/DataModel/vtkBond.h