Class AtomType
java.lang.Object
org.openscience.cdk.ChemObject
org.openscience.cdk.Element
org.openscience.cdk.Isotope
org.openscience.cdk.AtomType
- All Implemented Interfaces:
Serializable, Cloneable, IAtomType, ICDKObject, IChemObject, IElement, IIsotope
- Direct Known Subclasses:
Atom, DebugAtomType
The base class for atom types. Atom types are typically used to describe the
behaviour of an atom of a particular element in different environment like
sp3
hybridized carbon C3, etc., in some molecular modelling applications.
- Author:
- steinbeck
- See Also:
- Keywords:
- atom, type
- Created on:
- 2001-08-08
-
Nested Class Summary
Nested classes/interfaces inherited from interface IAtomType
IAtomType.HybridizationModifier and TypeInterfaceDescriptionstatic enumAn enum for the different hybridization states. -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected IntegerThe electron Valency of this atom with CDKConstants.UNSET as default.protected IntegerThe formal charge of the atom with CDKConstants.UNSET as default.protected IntegerThe formal number of neighbours this atom type can have with CDKConstants_UNSET as default.protected IAtomType.HybridizationThe hybridization state of this atom with CDKConstants.HYBRIDIZATION_UNSET as default.Fields inherited from class Isotope
exactMass, naturalAbundanceModifier and TypeFieldDescriptionExact mass of this isotope.Natural abundance of this isotope.Fields inherited from class Element
atomicNumberModifier and TypeFieldDescriptionprotected IntegerThe atomic number for this element giving their position in the periodic table.Fields inherited from interface IChemObject
ALIPHATIC, AROMATIC, CONJUGATED, HIDDEN, HYDROGEN_BOND_ACCEPTOR, HYDROGEN_BOND_DONOR, IN_RING, MAPPED, MARKUSH, NOT_IN_RING, PLACED, REACTIVE_CENTER, SINGLE_OR_DOUBLE, TYPEABLE, VISITEDModifier and TypeFieldDescriptionstatic final intFlag that is set if a ChemObject is part of an aliphatic chain.static final intFlag is set if ChemObject is part of an aromatic system.static final intFlag is set if ChemObject is part of a conjugated system.static final intThis flag can be used when depicted structures to hide certain parts, for example the things are abbreviated (display shortcuts).static final intSets to true if the atom is a hydrogen bond acceptor.static final intSets to true if the atom is a hydrogen bond donor.static final intFlag that is set when the ChemObject is part of a ring.static final intFlag is set if a ChemObject is mapped to another ChemObject.static final intFlag to indicate a flattened molecule holds a Markush structure, you can work on it as is or it might make more sense to repack into something sensible like a RGroupQuery.static final intFlag that is set when the ChemObject is part of a ring.static final intFlag that is set if the ChemObject is placed when calculating 2D/3D layouts.static final intFlag is set if a ChemObject has reactive center.static final intFlag used for marking uncertainty of the bond order.static final intFlag is set if an atom could be typed.static final intFlag is set if ChemObject has been visited.Fields inherited from interface IElement
Ac, Ag, Al, Am, Ar, As, At, Au, B, Ba, Be, Bh, Bi, Bk, Br, C, Ca, Cd, Ce, Cf, Cl, Cm, Cn, Co, Cr, Cs, Cu, Db, Ds, Dy, Er, Es, Eu, F, Fe, Fl, Fm, Fr, Ga, Gd, Ge, H, He, Hf, Hg, Ho, Hs, I, In, Ir, K, Kr, La, Li, Lr, Lu, Lv, Mc, Md, Mg, Mn, Mo, Mt, N, Na, Nb, Nd, Ne, Nh, Ni, No, Np, O, Og, Os, P, Pa, Pb, Pd, Pm, Po, Pr, Pt, Pu, Ra, Rb, Re, Rf, Rg, Rh, Rn, Ru, S, Sb, Sc, Se, Sg, Si, Sm, Sn, Sr, Ta, Tb, Tc, Te, Th, Ti, Tl, Tm, Ts, U, V, W, Wildcard, Xe, Y, Yb, Zn, ZrModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intCarbon atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intHydrogen atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intNitrogen atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intOxygen atomic numberstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intWildcard atom is atomic number 0static final intstatic final intstatic final intstatic final intstatic final int -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedAtomType()Constructor for the AtomType object.Constructor for the AtomType object.Constructs an isotope by copying the symbol, atomic number, flags, identifier, exact mass, natural abundance and mass number from the given IIsotope. -
Method Summary
Modifier and TypeMethodDescriptionclone()Clones thisIChemObject.booleanCompares a atom type with this atom type.Gets the id attribute of the AtomType object.Gets the bondOrderSum attribute of the AtomType object.Returns the covalent radius for this AtomType.Returns the formal charge of this atom.Returns the formal neighbour count of this atom.Returns the hybridization of this atom.Gets the MaxBondOrder attribute of the AtomType object.Gets the the exact electron valency of the AtomType object.voidsetAtomTypeName(String identifier) Sets the if attribute of the AtomType object.voidsetBondOrderSum(Double bondOrderSum) Sets the the exact bond order sum attribute of the AtomType object.voidsetCovalentRadius(Double radius) Sets the covalent radius for this AtomType.voidsetFormalCharge(Integer charge) Sets the formal charge of this atom.voidsetFormalNeighbourCount(Integer count) Sets the formal neighbour count of this atom.voidsetHybridization(IAtomType.Hybridization hybridization) Sets the hybridization of this atom.voidsetMaxBondOrder(IBond.Order maxBondOrder) Sets the MaxBondOrder attribute of the AtomType object.voidsetValency(Integer valency) Sets the the exact electron valency of the AtomType object.toString()A string representation of this isotope.Methods inherited from class Isotope
getExactMass, getMassNumber, getNaturalAbundance, setExactMass, setMassNumber, setNaturalAbundanceModifier and TypeMethodDescriptionGets the ExactMass attribute of the Isotope object.Returns the atomic mass of this element.Gets the NaturalAbundance attribute of the Isotope object.voidsetExactMass(Double exactMass) Sets the ExactMass attribute of the Isotope object.voidsetMassNumber(Integer massNumber) Sets the atomic mass of this element.voidsetNaturalAbundance(Double naturalAbundance) Sets the NaturalAbundance attribute of the Isotope object.Methods inherited from class Element
getAtomicNumber, getSymbol, setAtomicNumber, setSymbolModifier and TypeMethodDescriptionReturns the atomic number of this element.Returns the element symbol of this element.voidsetAtomicNumber(Integer atomicNumber) Sets the atomic number of this element.voidSets the element symbol of this element.Methods inherited from class ChemObject
addListener, addProperties, clear, flags, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, is, notifyChanged, notifyChanged, removeListener, removeProperty, set, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopyModifier and TypeMethodDescriptionvoidUse this to add yourself to this IChemObject as a listener.voidaddProperties(Map<Object, Object> properties) Sets the properties of this object.voidclear(int flags) Clear the provided flags.intflags()Access the current value of the flags for this ChemObject.Returns aIChemObjectBuilderfor the data classes that extend this class.booleangetFlag(int mask) Returns the value of a given flag.boolean[]getFlags()Returns the whole set of flags.Access the internal value used to store the flags.getID()Returns the identifier (ID) of this object.intReturns the number of ChemObjectListeners registered with this object.booleanReturns the flag that indicates whether notification messages are sent around.Returns a Map with the IChemObject's properties.<T> TgetProperty(Object description) Returns a property for the IChemObject.<T> TgetProperty(Object description, Class<T> c) Access a property of the given description and cast the specified class.booleanis(int flags) Test if a flag(s) are set on this ChemObject.voidThis should be triggered by an method that changes the content of an object to that the registered listeners can react to it.voidThis should be triggered by an method that changes the content of an object to that the registered listeners can react to it.voidUse this to remove a ChemObjectListener from the ListenerList of this IChemObject.voidremoveProperty(Object description) Removes a property for a IChemObject.voidset(int flags) Set the provided flags.voidsetFlag(int mask, boolean value) Sets the value of some flag.voidsetFlags(boolean[] flagsNew) Sets the whole set of flags.voidSets the identifier (ID) of this object.voidsetNotification(boolean bool) Set a flag to use or not use notification.voidsetProperties(Map<Object, Object> properties) Set the properties of this object to the provided map (shallow copy).voidsetProperty(Object description, Object property) Sets a property for a IChemObject.Clones thisIChemObject, but preserves references toObjects.
-
Field Details
-
formalCharge
The formal charge of the atom with CDKConstants.UNSET as default. Implements RFC #6. Note that some constructors (AtomType(String)andAtomType(String, String)) will explicitly set this field to 0 -
hybridization
The hybridization state of this atom with CDKConstants.HYBRIDIZATION_UNSET as default. -
electronValency
The electron Valency of this atom with CDKConstants.UNSET as default. -
formalNeighbourCount
The formal number of neighbours this atom type can have with CDKConstants_UNSET as default. This includes explicitely and implicitly connected atoms, including implicit hydrogens.
-
-
Constructor Details
-
AtomType
protected AtomType() -
AtomType
Constructor for the AtomType object. Defaults to a zero formal charge. All other fields are set toCDKConstants.UNSET.- Parameters:
elementSymbol- Symbol of the atom
-
AtomType
-
AtomType
Constructs an isotope by copying the symbol, atomic number, flags, identifier, exact mass, natural abundance and mass number from the given IIsotope. It does not copy the listeners and properties. If the element is an instance of IAtomType, then the maximum bond order, bond order sum, van der Waals and covalent radii, formal charge, hybridization, electron valency, formal neighbour count and atom type name are copied too.- Parameters:
element- IIsotope to copy information from
-
-
Method Details
-
setAtomTypeName
Sets the if attribute of the AtomType object.- Specified by:
setAtomTypeNamein interfaceIAtomType- Parameters:
identifier- The new AtomTypeID value. Null if unset.- See Also:
-
setMaxBondOrder
Sets the MaxBondOrder attribute of the AtomType object.- Specified by:
setMaxBondOrderin interfaceIAtomType- Parameters:
maxBondOrder- The new MaxBondOrder value- See Also:
-
setBondOrderSum
Sets the the exact bond order sum attribute of the AtomType object.- Specified by:
setBondOrderSumin interfaceIAtomType- Parameters:
bondOrderSum- The new bondOrderSum value- See Also:
-
getAtomTypeName
Gets the id attribute of the AtomType object.- Specified by:
getAtomTypeNamein interfaceIAtomType- Returns:
- The id value
- See Also:
-
getMaxBondOrder
Gets the MaxBondOrder attribute of the AtomType object.- Specified by:
getMaxBondOrderin interfaceIAtomType- Returns:
- The MaxBondOrder value
- See Also:
-
getBondOrderSum
Gets the bondOrderSum attribute of the AtomType object.- Specified by:
getBondOrderSumin interfaceIAtomType- Returns:
- The bondOrderSum value
- See Also:
-
setFormalCharge
Sets the formal charge of this atom.- Specified by:
setFormalChargein interfaceIAtomType- Parameters:
charge- The formal charge- See Also:
-
getFormalCharge
Returns the formal charge of this atom.- Specified by:
getFormalChargein interfaceIAtomType- Returns:
- the formal charge of this atom
- See Also:
-
setFormalNeighbourCount
Sets the formal neighbour count of this atom.- Specified by:
setFormalNeighbourCountin interfaceIAtomType- Parameters:
count- The neighbour count- See Also:
-
getFormalNeighbourCount
Returns the formal neighbour count of this atom.- Specified by:
getFormalNeighbourCountin interfaceIAtomType- Returns:
- the formal neighbour count of this atom
- See Also:
-
setHybridization
Sets the hybridization of this atom.- Specified by:
setHybridizationin interfaceIAtomType- Parameters:
hybridization- The hybridization- See Also:
-
getHybridization
Returns the hybridization of this atom.- Specified by:
getHybridizationin interfaceIAtomType- Returns:
- the hybridization of this atom
- See Also:
-
compare
-
setCovalentRadius
Sets the covalent radius for this AtomType.- Specified by:
setCovalentRadiusin interfaceIAtomType- Parameters:
radius- The covalent radius for this AtomType- See Also:
-
getCovalentRadius
Returns the covalent radius for this AtomType.- Specified by:
getCovalentRadiusin interfaceIAtomType- Returns:
- The covalent radius for this AtomType
- See Also:
-
setValency
Sets the the exact electron valency of the AtomType object.- Specified by:
setValencyin interfaceIAtomType- Parameters:
valency- The new valency value- See Also:
-
getValency
Gets the the exact electron valency of the AtomType object.- Specified by:
getValencyin interfaceIAtomType- Returns:
- The valency value
- See Also:
-
clone
Description copied from class:ChemObjectClones thisIChemObject. It clones the identifier, flags, properties and pointer vectors. The ChemObjectListeners are not cloned, and neither is the content of the pointer vectors.- Specified by:
clonein interfaceIChemObject- Overrides:
clonein classIsotope- Returns:
- The cloned object
- Throws:
CloneNotSupportedException- if the IChemObject cannot be cloned
-
toString
-