vtkBond Class Reference

convenience proxy for vtkMolecule More...

#include <vtkBond.h>

Collaboration diagram for vtkBond:

Public Member Functions
void	PrintSelf (ostream &os, vtkIndent indent)
vtkIdType	GetId () const
	Return the Id used to identify this bond in the parent molecule. More...
vtkMolecule *	GetMolecule ()
	Return the parent molecule of this bond. More...
unsigned short	GetOrder ()
	Get the bond order for this bond. More...
double	GetLength () const
	Get the distance between the bonded atoms. More...
vtkIdType	GetBeginAtomId () const
	Get the starting / ending atom ids for this bond. More...
vtkIdType	GetEndAtomId () const
	Get the starting / ending atom ids for this bond. More...
vtkAtom	GetBeginAtom ()
	Get a vtkAtom object that refers to the starting / ending atom for this bond. More...
vtkAtom	GetEndAtom ()
	Get a vtkAtom object that refers to the starting / ending atom for this bond. More...
const vtkAtom	GetBeginAtom () const
	Get a vtkAtom object that refers to the starting / ending atom for this bond. More...
const vtkAtom	GetEndAtom () const
	Get a vtkAtom object that refers to the starting / ending atom for this bond. More...

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 33 of file vtkBond.h.

Constructor & Destructor Documentation

vtkBond()

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

protected

Member Function Documentation

PrintSelf()

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

GetId()

vtkIdType vtkBond::GetId ( ) const

inline

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

Definition at line 92 of file vtkBond.h.

GetMolecule()

vtkMolecule * vtkBond::GetMolecule ( )

inline

Return the parent molecule of this bond.

Definition at line 97 of file vtkBond.h.

GetBeginAtomId()

vtkIdType vtkBond::GetBeginAtomId

(

)

const

Get the starting / ending atom ids for this bond.

GetEndAtomId()

vtkIdType vtkBond::GetEndAtomId

(

)

const

Get the starting / ending atom ids for this bond.

GetBeginAtom() [1/2]

vtkAtom vtkBond::GetBeginAtom

(

)

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

GetEndAtom() [1/2]

vtkAtom vtkBond::GetEndAtom

(

)

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

GetBeginAtom() [2/2]

const vtkAtom vtkBond::GetBeginAtom

(

)

const

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

GetEndAtom() [2/2]

const vtkAtom vtkBond::GetEndAtom

(

)

const

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

GetOrder()

unsigned short vtkBond::GetOrder

(

)

Get the bond order for this bond.

GetLength()

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

vtkMolecule

friend class vtkMolecule

friend

Definition at line 81 of file vtkBond.h.

Member Data Documentation

Molecule

vtkMolecule* vtkBond::Molecule

protected

Definition at line 86 of file vtkBond.h.

Id

vtkIdType vtkBond::Id

protected

Definition at line 87 of file vtkBond.h.

BeginAtomId

vtkIdType vtkBond::BeginAtomId

protected

Definition at line 88 of file vtkBond.h.

EndAtomId

vtkIdType vtkBond::EndAtomId

protected

Definition at line 89 of file vtkBond.h.

---

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

• dox/Common/DataModel/vtkBond.h