Package org.openscience.cdk.silent
Class RingSet
java.lang.Object
org.openscience.cdk.silent.ChemObject
org.openscience.cdk.silent.AtomContainerSet
org.openscience.cdk.silent.RingSet
- All Implemented Interfaces:
Serializable
,Cloneable
,IAtomContainerSet
,ICDKObject
,IChemObject
,IChemObjectListener
,IRingSet
Maintains a set of Ring objects.
- See Also:
- Source code:
- main
- Belongs to CDK module:
- silent
- Keywords:
- ring, set of
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Flag to denote that the set is order with the largest ring first?static final int
Flag to denote that the set is order with the smallest ring first?Fields inherited from class org.openscience.cdk.silent.AtomContainerSet
atomContainerCount, atomContainers, growArraySize, multipliers
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Adds all rings of another RingSet if they are not already part of this ring set.clone()
Clones thisRingSet
including the Rings.boolean
True, if at least one of the rings in the ringset contains the given atom.boolean
contains
(IAtomContainer ring) Checks for presence of a ring in this RingSet.getConnectedRings
(IRing ring) Returns all the rings in the RingSet that share one or more atoms with a given ring.Returns a vector of all rings that this atom is part of.Returns a vector of all rings that this bond is part of.toString()
Returns the String representation of this RingSet.Methods inherited from class org.openscience.cdk.silent.AtomContainerSet
add, addAtomContainer, addAtomContainer, atomContainers, getAtomContainer, getAtomContainerCount, getMultiplier, getMultiplier, getMultipliers, growAtomContainerArray, isEmpty, removeAllAtomContainers, removeAtomContainer, removeAtomContainer, replaceAtomContainer, setMultiplier, setMultiplier, setMultipliers, sortAtomContainers, stateChanged
Methods inherited from class org.openscience.cdk.silent.ChemObject
addListener, addProperties, compare, getBuilder, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty, shallowCopy
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.openscience.cdk.interfaces.IAtomContainerSet
add, addAtomContainer, addAtomContainer, atomContainers, getAtomContainer, getAtomContainerCount, getMultiplier, getMultiplier, getMultipliers, removeAllAtomContainers, removeAtomContainer, removeAtomContainer, replaceAtomContainer, setMultiplier, setMultiplier, setMultipliers, sortAtomContainers
Methods inherited from interface org.openscience.cdk.interfaces.ICDKObject
getBuilder
Methods inherited from interface org.openscience.cdk.interfaces.IChemObject
addListener, addProperties, getFlag, getFlags, getFlagValue, getID, getListenerCount, getNotification, getProperties, getProperty, getProperty, notifyChanged, notifyChanged, removeListener, removeProperty, setFlag, setFlags, setID, setNotification, setProperties, setProperty
-
Field Details
-
LARGE_FIRST
public static final int LARGE_FIRSTFlag to denote that the set is order with the largest ring first?- See Also:
-
SMALL_FIRST
public static final int SMALL_FIRSTFlag to denote that the set is order with the smallest ring first?- See Also:
-
-
Constructor Details
-
RingSet
public RingSet()The constructor.
-
-
Method Details
-
getRings
Returns a vector of all rings that this bond is part of. -
getRings
Returns a vector of all rings that this atom is part of. -
getConnectedRings
Returns all the rings in the RingSet that share one or more atoms with a given ring.- Specified by:
getConnectedRings
in interfaceIRingSet
- Parameters:
ring
- A ring with which all return rings must share one or more atoms- Returns:
- All the rings that share one or more atoms with a given ring.
-
add
Adds all rings of another RingSet if they are not already part of this ring set. If you want to add a single ring to the set useAtomContainerSet.addAtomContainer(org.openscience.cdk.interfaces.IAtomContainer)
-
contains
True, if at least one of the rings in the ringset contains the given atom. -
contains
Checks for presence of a ring in this RingSet. -
clone
Clones thisRingSet
including the Rings.- Specified by:
clone
in interfaceIChemObject
- Overrides:
clone
in classAtomContainerSet
- Returns:
- The cloned object
- Throws:
CloneNotSupportedException
- if the IChemObject cannot be cloned
-
toString
Returns the String representation of this RingSet.- Specified by:
toString
in interfaceIChemObject
- Overrides:
toString
in classAtomContainerSet
- Returns:
- The String representation of this RingSet
-