API:IAtomType

From Wiketomica
Jump to: navigation, search
API Home Participants API Discussion Demos Downloads Documentation Contact Us Acknowledgements


IAtomType

Purpose

The IAtomType contains information common to all IAtoms of a particular type.

Proposed Interface

interface IAtomType {

    /**
     * The index for this IAtomType within the context of an ISimulation.
     * The index is the IAtomType's position in the list of IAtomTypes in
     * the ISimulation.
     */
    attribute int index;

    /**
     * The childIndex is the IAtomType's index within the context of its
     * parent species.  The childIndex is the IAtomType's position in the
     * list of IAtomTypes in the ISpecies.
     */
    attribute int childIndex;

    /**
     * The parent species of this IAtomType
     */
    attribute ISpecies species;

    /**
     * The mass of all IAtoms with this IAtomType
     */
    readonly attribute double mass;

    /**
     * Returns the reciprocal of the mass, 1.0/mass
     */
    double rm();

    /**
     * The (chemical) element for this IAtomType
     */
    readonly attribute IElement element;
}