The Octet Molecular Representation Framework v0.8.2

net.sf.octet.builder
Class AbstractRepresentationBuilder.AtomTemplate

java.lang.Object
  extended bynet.sf.octet.builder.AbstractRepresentationBuilder.AtomTemplate
All Implemented Interfaces:
AtomProxy
Enclosing class:
AbstractRepresentationBuilder

protected class AbstractRepresentationBuilder.AtomTemplate
extends java.lang.Object
implements AtomProxy

A template for the construction of represenation-specific atoms. 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 countImplicitHydrogens()
          Returns the number of implicit hydrogens associated with this AtomTemplate.
 int countOrbitalTemplates()
          Returns the number of OrbitalTemplates owned by this AtomTemplate.
 Atom getAtom()
          Returns the Atom owned by this AtomTemplate.
 AbstractRepresentationBuilder.ConfigurationTemplate getConfigurationTemplate()
          Returns the ConfigurationTemplate owned by this AtomTemplate.
 int getElectronCount()
          Returns the number of electrons owned by this AtomTemplate.
 AbstractRepresentationBuilder.OrbitalTemplate getOrbitalTemplate(int index)
          Returns the OrbitalTemplate at the specified index.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getAtom

public Atom getAtom()
Returns the Atom owned by this AtomTemplate.

Returns:
the Atom owned by this AtomTemplate

getElectronCount

public int getElectronCount()
Returns the number of electrons owned by this AtomTemplate.

Returns:
the number of electrons owned by this AtomTemplate

countOrbitalTemplates

public int countOrbitalTemplates()
Returns the number of OrbitalTemplates owned by this AtomTemplate.

Returns:
the number of OrbitalTemplates owned by this AtomTemplate

getOrbitalTemplate

public AbstractRepresentationBuilder.OrbitalTemplate getOrbitalTemplate(int index)
Returns the OrbitalTemplate at the specified index.

Parameters:
index - the index to address
Returns:
the OrbitalTemplate at the specified index

getConfigurationTemplate

public AbstractRepresentationBuilder.ConfigurationTemplate getConfigurationTemplate()
Returns the ConfigurationTemplate owned by this AtomTemplate.

Returns:
the ConfigurationTemplate owned by this AtomTemplate

countImplicitHydrogens

public int countImplicitHydrogens()
Returns the number of implicit hydrogens associated with this AtomTemplate.

Returns:
the number of implicit hydrogens associated with this AtomTemplate

The Octet Molecular Representation Framework v0.8.2