net.sf.octet.builder
Class AbstractRepresentationBuilder.PaddleWheelTemplate

java.lang.Object
  net.sf.octet.builder.AbstractRepresentationBuilder.PaddleWheelTemplate

Enclosing class:

AbstractRepresentationBuilder

protected class AbstractRepresentationBuilder.PaddleWheelTemplate

extends java.lang.Object

A template for the construction of represenation-specific paddle wheels. Note that this class is not immutable; values returned may differ from those returned by previous or subsequent method invocations.

Author:

Richard Apodaca

Method Summary

int	countHalfPlaneTemplates() Returns the number of HalfPlaneTemplates owned by this PaddleWheelTemplate.
AtomPair	getAxis() Returns the AtomPair forming the axis of this PaddleWheelTemplate.
AbstractRepresentationBuilder.HalfPlaneTemplate	getHalfPlaneTemplate(int index) Returns the HalfPlaneTemplate located at index.

Methods inherited from class java.lang.Object

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

Method Detail

countHalfPlaneTemplates

public int countHalfPlaneTemplates()

Returns the number of HalfPlaneTemplates owned by this PaddleWheelTemplate.

Returns:

the number of HalfPlaneTemplates owned by this PaddleWheelTemplate

getHalfPlaneTemplate

public AbstractRepresentationBuilder.HalfPlaneTemplate getHalfPlaneTemplate(int index)

Returns the HalfPlaneTemplate located at index.

Parameters:

index - the index to query

Returns:

the HalfPlaneTemplate located at index

getAxis

public AtomPair getAxis()

Returns the AtomPair forming the axis of this PaddleWheelTemplate.

Returns:

the AtomPair forming the axis of this PaddleWheelTemplate