 |
Chemical Data Processing Library Python API - Version 1.4.0
|
|
Chemical Data Processing Library Python API - Version 1.4.0
|
Abstract base class for grid types that also carry generic key/value properties. More...
Inheritance diagram for CDPL.Grid.AttributedGrid:Public Member Functions | |
| None | __init__ () |
Contructs the AttributedGrid instance. | |
| bool | isEmpty () |
| Tells whether the grid is empty. More... | |
| int | getNumElements () |
| Returns the total number of grid elements. More... | |
| int | __len__ () |
| Returns the number of property entries. More... | |
| Base.Any | __getitem__ (Base.LookupKey key) |
| bool | __contains__ (Base.LookupKey key) |
Returns the result of the membership test operation key in self. More... | |
| None | __setitem__ (Base.LookupKey key, Base.Any val) |
| bool | __delitem__ (Base.LookupKey key) |
| Public Member Functions inherited from CDPL.Base.PropertyContainer | |
| int | getObjectID () |
| Returns the numeric identifier (ID) of the wrapped C++ class instance. More... | |
| int | getNumProperties () |
| Returns the number of property entries. More... | |
| Any | getPropertyOrDefault (LookupKey key, Any def_val) |
| Returns the value of the property specified by key , or the default value def_val if an entry does not exist. More... | |
| list | getPropertyKeys () |
| Returns a list containing the keys of the current property entries. More... | |
| list | getPropertyValues () |
| Returns a list containing the values of the current property entries. More... | |
| list | getProperties () |
| Returns a reference to itself. More... | |
| None | setProperty (LookupKey key, Any val) |
| Sets the value of the property specified by key to val. More... | |
| bool | removeProperty (LookupKey key) |
| Removes the entry for the property specified by key. More... | |
| Any | getProperty (LookupKey key, bool throw_=False) |
| Returns the value of the property specified by key. More... | |
| bool | isPropertySet (LookupKey key) |
| Tells whether or not a value has been assigned to the property specified by key. More... | |
| None | clearProperties () |
| Erases all container entries. | |
| None | addProperties (PropertyContainer cntnr) |
Adds the property entries of the PropertyContainer instance cntnr. More... | |
| None | copyProperties (PropertyContainer cntnr) |
| Replaces the current property entries by a copy of the entries in cntnr. More... | |
| None | swap (PropertyContainer cntnr) |
| Exchanges the property entries of this container with the ones of cntnr. More... | |
| Any | __getitem__ (LookupKey key) |
| Returns the value of the property specified by key. More... | |
| bool | __contains__ (LookupKey key) |
| Tells whether or not a value has been assigned to the property specified by key. More... | |
| None | __setitem__ (LookupKey key, Any val) |
| Sets the value of the property specified by key to val. More... | |
| bool | __delitem__ (LookupKey key) |
| Removes the entry for the property specified by key. More... | |
Properties | |
| numElements = property(getNumElements) | |
| Properties inherited from CDPL.Base.PropertyContainer | |
| objectID = property(getObjectID) | |
| propertyKeys = property(getPropertyKeys) | |
| propertyValues = property(getPropertyValues) | |
| properties = property(getProperties) | |
| numProperties = property(getNumProperties) | |
Abstract base class for grid types that also carry generic key/value properties.
AttributedGrid combines the property-bag interface from Base.PropertyContainer with the minimal grid interface required to know the number of grid elements and whether the grid is empty. Concrete grid types (e.g. Grid.RegularGrid) implement the pure virtual member functions.
| bool CDPL.Grid.AttributedGrid.isEmpty | ( | ) |
Tells whether the grid is empty.
True if the grid is empty, and False otherwise. Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.
| int CDPL.Grid.AttributedGrid.getNumElements | ( | ) |
Returns the total number of grid elements.
Reimplemented in CDPL.Grid.FSpatialGrid, and CDPL.Grid.DSpatialGrid.
| int CDPL.Grid.AttributedGrid.__len__ | ( | ) |
Returns the number of property entries.
Reimplemented from CDPL.Base.PropertyContainer.
Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.
| bool CDPL.Grid.AttributedGrid.__contains__ | ( | Base.LookupKey | key | ) |
Returns the result of the membership test operation key in self.
| key | The value to test for membership. |
Reimplemented in CDPL.Grid.FSpatialGrid, CDPL.Grid.FRegularGrid, CDPL.Grid.DSpatialGrid, and CDPL.Grid.DRegularGrid.
1.9.1