Package org.openscience.cdk.geometry.cip

Class VisitedAtoms

java.lang.Object

org.openscience.cdk.geometry.cip.VisitedAtoms

public class VisitedAtoms
extends Object

Helper class for the CIPTool to keep track of which atoms have already been visited.

Source code:

main

Belongs to CDK module:

cip

Constructor Summary

Constructors

Constructor	Description
VisitedAtoms()	Creates a new empty list of visited IAtoms.

Method Summary

Modifier and Type	Method	Description
boolean	isVisited(IAtom atom)	Returns true if the given atom already has been visited.
void	visited(VisitedAtoms visitedAtoms)	Adds all atoms from the visitedAtoms list to the current list.
void	visited(IAtom atom)	Marks the given atom as visited.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

VisitedAtoms

public VisitedAtoms()

Creates a new empty list of visited IAtoms.

Method Details

isVisited

public boolean isVisited(IAtom atom)

Returns true if the given atom already has been visited.

Parameters:

atom - IAtom which may have been visited

Returns:

true if the IAtom was visited

visited

public void visited(IAtom atom)

Marks the given atom as visited.

Parameters:

atom - IAtom that is now marked as visited

visited

public void visited(VisitedAtoms visitedAtoms)

Adds all atoms from the visitedAtoms list to the current list.

Parameters:

visitedAtoms - the VisitedAtoms from which all atoms are added