Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | List of all members
CDPL.Chem.PiElectronSystemList Class Reference

Implements the perception of all pi electron systems present in a molecule. More...

+ Inheritance diagram for CDPL.Chem.PiElectronSystemList:

Public Member Functions

None __init__ ()
 Constructs an empty PiElectronSystemList instance.
 
None __init__ (MolecularGraph molgraph)
 Constructs a PiElectronSystemList instance storing all pi electron systems of the molecular graph molgraph. More...
 
None perceive (MolecularGraph molgraph)
 Perceives all pi electron systems present in the molecular graph molgraph. More...
 
- Public Member Functions inherited from CDPL.Chem.ElectronSystemList
None __init__ (ElectronSystemList list)
 Initializes a copy of the ElectronSystemList instance list. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
int getSize ()
 
bool isEmpty ()
 
None resize (int num_elem, ElectronSystem value)
 
None reserve (int num_elem)
 
int getCapacity ()
 
None clear ()
 
ElectronSystemList assign (ElectronSystemList array)
 Replaces the current state of self with a copy of the state of the ElectronSystemList instance array. More...
 
None assign (int num_elem, ElectronSystem value)
 
None addElement (ElectronSystem value)
 
None addElements (ElectronSystemList values)
 
None insertElement (int idx, ElectronSystem value)
 
None insertElements (int idx, int num_elem, ElectronSystem value)
 
None insertElements (int index, ElectronSystemList values)
 
None popLastElement ()
 
None removeElement (int idx)
 
None removeElements (int begin_idx, int end_idx)
 
ElectronSystem getFirstElement ()
 
ElectronSystem getLastElement ()
 
ElectronSystem getElement (int idx)
 
None setElement (int idx, ElectronSystem value)
 
None __delitem__ (int idx)
 
ElectronSystem __getitem__ (int idx)
 
int __len__ ()
 
None __setitem__ (int index, ElectronSystem value)
 
bool __eq__ (object list)
 Returns the result of the comparison operation self == list. More...
 
bool __ne__ (object list)
 Returns the result of the comparison operation self != list. More...
 

Additional Inherited Members

- Properties inherited from CDPL.Chem.ElectronSystemList
 objectID = property(getObjectID)
 
 size = property(getSize)
 

Detailed Description

Implements the perception of all pi electron systems present in a molecule.

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Chem.PiElectronSystemList.__init__ ( MolecularGraph  molgraph)

Constructs a PiElectronSystemList instance storing all pi electron systems of the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to perceive the pi electron systems.

Member Function Documentation

◆ perceive()

None CDPL.Chem.PiElectronSystemList.perceive ( MolecularGraph  molgraph)

Perceives all pi electron systems present in the molecular graph molgraph.

Parameters
molgraphThe molecular graph for which to perceive the pi electron systems.