Chemical Data Processing Library Python API - Version 1.4.0
Public Member Functions | List of all members
CDPL.Grid.DSpatialGrid Class Reference

Convenience alias for the double-precision spatial-grid abstract base. More...

+ Inheritance diagram for CDPL.Grid.DSpatialGrid:

Public Member Functions

None __init__ ()
 Contructs the DSpatialGrid instance.
 
bool isEmpty ()
 Tells whether the grid is empty. More...
 
int getNumElements ()
 Returns the total number of grid elements. More...
 
float getElement (int i)
 
None setElement (int i, float value)
 
None getCoordinates (int i, Math.Vector3D coords)
 Returns the 3D coordinates of the grid element at linear index i. More...
 
float __call__ (int i)
 Returns the grid element at linear index i. More...
 
int __len__ ()
 Returns the number of property entries. More...
 
float __getitem__ (int i)
 
Base.Any __getitem__ (Base.LookupKey key)
 
None __setitem__ (int i, float value)
 
None __setitem__ (Base.LookupKey key, Base.Any val)
 
bool __contains__ (Base.LookupKey key)
 Returns the result of the membership test operation key in self. More...
 
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...
 

Additional Inherited Members

- Properties inherited from CDPL.Grid.AttributedGrid
 numElements = property(getNumElements)
 
- Properties inherited from CDPL.Base.PropertyContainer
 objectID = property(getObjectID)
 
 propertyKeys = property(getPropertyKeys)
 
 propertyValues = property(getPropertyValues)
 
 properties = property(getProperties)
 
 numProperties = property(getNumProperties)
 

Detailed Description

Convenience alias for the double-precision spatial-grid abstract base.

Member Function Documentation

◆ isEmpty()

bool CDPL.Grid.DSpatialGrid.isEmpty ( )

Tells whether the grid is empty.

Returns
True if the grid is empty, and False otherwise.

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.DRegularGrid.

◆ getNumElements()

int CDPL.Grid.DSpatialGrid.getNumElements ( )

Returns the total number of grid elements.

Returns
The number of grid elements.

Reimplemented from CDPL.Grid.AttributedGrid.

◆ getCoordinates()

None CDPL.Grid.DSpatialGrid.getCoordinates ( int  i,
Math.Vector3D  coords 
)

Returns the 3D coordinates of the grid element at linear index i.

Parameters
iThe linear element index.
coordsThe output coordinates.

◆ __call__()

float CDPL.Grid.DSpatialGrid.__call__ ( int  i)

Returns the grid element at linear index i.

Parameters
iThe linear element index.
Returns
The grid element.

Reimplemented in CDPL.Grid.DRegularGrid.

◆ __len__()

int CDPL.Grid.DSpatialGrid.__len__ ( )

Returns the number of property entries.

Returns
The number of property entries.

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.DRegularGrid.

◆ __contains__()

bool CDPL.Grid.DSpatialGrid.__contains__ ( Base.LookupKey  key)

Returns the result of the membership test operation key in self.

Parameters
keyThe value to test for membership.
Returns
The result of the membership test operation.

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.DRegularGrid.