etomica.api
Interface IAtom

All Known Subinterfaces:

IAtomKinetic, IAtomOriented, IAtomOrientedKinetic

All Known Implementing Classes:

Atom, AtomLeafDynamic, AtomOriented, AtomOrientedDynamic

public interface IAtom

Method Summary

int	getIndex() Returns this IAtom's index, which is its place in the parent AtomGroup's list of child IAtoms.
int	getLeafIndex() Returns the global index (within the Box) of this Atom.
IMolecule	getParentGroup() Returns the parent AtomGruop of this IAtom.
IVectorMutable	getPosition() Returns the position of the IAtom.
IAtomType	getType()
void	setIndex(int index) Informs the IAtom of its index, which is used to construct the address.
void	setLeafIndex(int newGlobalIndex) Sets the atom's global index to the give value.
void	setParent(IMolecule newParent) Informs the Atom that the given AtomGroup is its parent.

Method Detail

getIndex

int getIndex()

Returns this IAtom's index, which is its place in the parent AtomGroup's list of child IAtoms.

setIndex

void setIndex(int index)

Informs the IAtom of its index, which is used to construct the address.

setLeafIndex

void setLeafIndex(int newGlobalIndex)

Sets the atom's global index to the give value. This method should only be called by the IBox.

getLeafIndex

int getLeafIndex()

Returns the global index (within the Box) of this Atom. The global index is unique to the IAtom in the Box. The IAtom's global may change over the course of a simulation due to addition or removal of other IAtoms in the Box. An BoxGlobalAtomIndexEvent is fired by the Box's event manager when an Atom's global index changes.

setParent

void setParent(IMolecule newParent)

Informs the Atom that the given AtomGroup is its parent. This method should only be called by the parent.

getParentGroup

IMolecule getParentGroup()

Returns the parent AtomGruop of this IAtom.

getType

IAtomType getType()

Returns:

the Atom type, holding properties held in common with other atoms made by this atom's factory.

getPosition

IVectorMutable getPosition()

Returns the position of the IAtom. Modifying the returned IVector will alter the IAtom's position.