net.sf.octet.model
Interface IsotopicDistribution

All Superinterfaces:

NucleusCollection

public interface IsotopicDistribution

extends NucleusCollection

A distribution of Nuclei. IsotopicDistribution extends the NucleusCollection interface to enable the relative abundances of Nuclei to be queried.

IsotopicDistribution restricts the NucleusCollection contract by disallowing duplicate Nucleus objects as determined by Object.equals and Nucleus objects of differing atomic number.

Implementors can use any Measurement to indicate relative abundance, provided that the results of all getAbundance queries are consistent.

All method invocations of IsotopicDistribution can be assumed to return the same results over the lifetime of implementing objects. In other words, IsotopicDistribution is an instance of the Immutable Pattern.

Author:

Richard Apodaca

Method Summary

Measurement	getAbundance(Nucleus nucleus) Returns the relative abundance of nucleus within this IsotopicDistribution.
AtomicSymbol	getAtomicSymbol() Returns the AtomicSymbol representing this IsotopicDistribution.
Nucleus	getMostAbundantNucleus() Returns the most abundant Nucleus in this IsotopicDistribution.
boolean	isNaturalAbundance() Returns true if this IsotopicDistribution represents natural isotopic abundance, or false otherwise.

Methods inherited from interface net.sf.octet.collection.NucleusCollection

containsNucleus, countNuclei, getNucleus, getNucleusIndex, iterateNuclei, toNucleusArray

Method Detail

getMostAbundantNucleus

public Nucleus getMostAbundantNucleus()

Returns the most abundant Nucleus in this IsotopicDistribution.

Returns:

the most abundant Nucleus in this IsotopicDistribution

getAbundance

public Measurement getAbundance(Nucleus nucleus)

Returns the relative abundance of nucleus within this IsotopicDistribution.

Parameters:

nucleus - the Nucleus

Returns:

the relative abundance of nucleus within this IsotopicDistribution, in arbitrary units

Throws:

NoSuchNucleusException - if nucleus can not be found

getAtomicSymbol

public AtomicSymbol getAtomicSymbol()

Returns the AtomicSymbol representing this IsotopicDistribution.

Returns:

the AtomicSymbol representing this IsotopicDistribution

isNaturalAbundance

public boolean isNaturalAbundance()

Returns true if this IsotopicDistribution represents natural isotopic abundance, or false otherwise.

Returns:

true if this IsotopicDistribution represents natural isotopic abundance, or false otherwise