The Octet Molecular Representation Framework v0.8.2

net.sf.octet.traversal
Interface CycleTraverser

All Known Implementing Classes:
HanserCycleTraverser

public interface CycleTraverser

Traverses the cycles of an AtomGraph. The order and completeness of cycle traversal will be implementation- dependent, as will be the order of Atom and AtomPair traversal within a paricular cycle. Each detected cycle will be traversed once.

Clients are notified of the various stages in the traversal algorithm by using a custom Handler . This is achieved by instantiating an object that implements Handler and invoking traverse with the object as an argument.

Author:
Richard Apodaca
See Also:
TraversalHandler

Nested Class Summary
static interface CycleTraverser.Handler
          An extension of the TraversalHandler interface that includes methods specific to CycleTraverser traversal.
 
Method Summary
 void traverse(AtomGraph graph, CycleTraverser.Handler handler)
          Traverses graph while notifying handler of traversal events.
 

Method Detail

traverse

public void traverse(AtomGraph graph,
                     CycleTraverser.Handler handler)
Traverses graph while notifying handler of traversal events.

Parameters:
graph - the AtomGraph to traverse
handler - receives traversal events

The Octet Molecular Representation Framework v0.8.2