net.sf.octet.builder
Class AbstractRepresentationBuilder.OrbitalTemplate

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

All Implemented Interfaces:

OrbitalProxy

Enclosing class:

AbstractRepresentationBuilder

protected class AbstractRepresentationBuilder.OrbitalTemplate

extends java.lang.Object

implements OrbitalProxy

A template for the construction of represenation-specific orbitals. 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	getSpin1() Returns the directionality of spin1.
int	getSpin2() Returns the directionality of spin2.
boolean	isEmpty() Returns true if neither spin in this OrbitalTemplate has been set.
boolean	isFull() Returns true if both spin1 and spin2 have been set.
boolean	isHalfFull() Returns true if only spin1 has been set.

Methods inherited from class java.lang.Object

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

Method Detail

getSpin1

public int getSpin1()

Returns the directionality of spin1.

Returns:

+1 (up), -1 (down), or 0 (not set)

getSpin2

public int getSpin2()

Returns the directionality of spin2.

Returns:

+1 (up), -1 (down), or 0 (not set)

isEmpty

public boolean isEmpty()

Returns true if neither spin in this OrbitalTemplate has been set.

Returns:

true if neither spin in this OrbitalTemplate has been set

isHalfFull

public boolean isHalfFull()

Returns true if only spin1 has been set.

Returns:

true if only spin1 has been set

isFull

public boolean isFull()

Returns true if both spin1 and spin2 have been set.

Returns:

true if both spin1 and spin2 have been set