Package schrodinger :: Module structure :: Class _Ring
[hide private]
[frames] | no frames]

Class _Ring

     object --+    
              |    
_AtomCollection --+
                  |
                 _Ring

Class representing a ring.

Important methods include extractStructure and getAtomIndices. The atom attribute returns an iterator over all atoms in the ring, and the number of atoms can be determined via len(molecule.atom). The edge attribute works in a similar manner for bonds in the ring.

Instance Methods [hide private]
 
__init__(self, st, ringnum, atoms, iterator)
x.__init__(...) initializes x; see help(type(x)) for signature
 
__str__(self)
str(x)
 
_getRingEdgeIterator(self)
 
isAromatic(self)
 
isHeteroaromatic(self)
 
applyStyle(self, atoms=3, bonds=3)
Applies the given display styles to the atoms and bonds of the ring.

Inherited from _AtomCollection: __len__, extractStructure, getAtomIndices, getAtomList

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Properties [hide private]
  edge
Returns a bond iterator for all edges in the ring.

Inherited from _AtomCollection: atom, structure, temperature_factor

Inherited from object: __class__

Method Details [hide private]

__init__(self, st, ringnum, atoms, iterator)
(Constructor)

 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__str__(self)
(Informal representation operator)

 

str(x)

Overrides: object.__str__
(inherited documentation)

applyStyle(self, atoms=3, bonds=3)

 

Applies the given display styles to the atoms and bonds of the ring.

Parameters:
  • atoms (int) - display style for atoms given by structure module constants ATOM_NOSTYLE, ATOM_CIRCLE, ATOM_CPK, ATOM_BALLNSTICK. Default is ATOM_BALLNSTICK.
  • atoms (int) - display style for bonds given by structure module constants BOND_NOSTYLE, BOND_WIRE, BOND_TUBE, BOND_BALLNSTICK. Default is BOND_BALLNSTICK.
  • bonds (int)

Property Details [hide private]

edge

Returns a bond iterator for all edges in the ring.

Get Method:
_getRingEdgeIterator(self)