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

SpatialGrid. More...

+ Inheritance diagram for CDPL.Grid.FSpatialGrid:

Public Member Functions

None __init__ ()
 Initializes the FSpatialGrid instance.
 
bool isEmpty ()
 
int getNumElements ()
 
float getElement (int i)
 
None setElement (int i, float value)
 
None getCoordinates (int i, Math.Vector3F coords)
 
float __call__ (int i)
 
int __len__ ()
 
float __getitem__ (int i)
 
Base.Any __getitem__ (Base.LookupKey key)
 
None __setitem__ (int i, float value)
 
None __setitem__ (Base.LookupKey key, Base.Any value)
 
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_value)
 
list getPropertyKeys ()
 
list getPropertyValues ()
 
list getProperties ()
 Returns a reference to itself. More...
 
None setProperty (LookupKey key, Any value)
 
bool removeProperty (LookupKey key)
 Clears the value of 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 ()
 Clears all property values.
 
None addProperties (PropertyContainer cntnr)
 Adds the property value entries in the PropertyContainer instance cntnr. More...
 
None copyProperties (PropertyContainer cntnr)
 Replaces the current set of properties by a copy of the entries in cntnr. More...
 
None swap (PropertyContainer cntnr)
 Exchanges the properties of this container with the properties of the container cntnr. More...
 
Any __getitem__ (LookupKey key)
 
bool __contains__ (LookupKey key)
 Returns the result of the membership test operation key in self. More...
 
None __setitem__ (LookupKey key, Any value)
 
bool __delitem__ (LookupKey key)
 

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

SpatialGrid.

Member Function Documentation

◆ isEmpty()

bool CDPL.Grid.FSpatialGrid.isEmpty ( )
Returns

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getNumElements()

int CDPL.Grid.FSpatialGrid.getNumElements ( )
Returns

Reimplemented from CDPL.Grid.AttributedGrid.

◆ getElement()

float CDPL.Grid.FSpatialGrid.getElement ( int  i)
Parameters
i
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ setElement()

None CDPL.Grid.FSpatialGrid.setElement ( int  i,
float  value 
)
Parameters
i
value

Reimplemented in CDPL.Grid.FRegularGrid.

◆ getCoordinates()

None CDPL.Grid.FSpatialGrid.getCoordinates ( int  i,
Math.Vector3F  coords 
)
Parameters
i
coords

◆ __call__()

float CDPL.Grid.FSpatialGrid.__call__ ( int  i)
Parameters
i
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __len__()

int CDPL.Grid.FSpatialGrid.__len__ ( )
Returns

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __getitem__() [1/2]

float CDPL.Grid.FSpatialGrid.__getitem__ ( int  i)
Parameters
i
Returns

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __getitem__() [2/2]

Base.Any CDPL.Grid.FSpatialGrid.__getitem__ ( Base.LookupKey  key)
Parameters
key
Returns

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __setitem__() [1/2]

None CDPL.Grid.FSpatialGrid.__setitem__ ( int  i,
float  value 
)
Parameters
i
value

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __setitem__() [2/2]

None CDPL.Grid.FSpatialGrid.__setitem__ ( Base.LookupKey  key,
Base.Any  value 
)
Parameters
key
value

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.FRegularGrid.

◆ __contains__()

bool CDPL.Grid.FSpatialGrid.__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.FRegularGrid.

◆ __delitem__()

bool CDPL.Grid.FSpatialGrid.__delitem__ ( Base.LookupKey  key)
Parameters
key
Returns

Reimplemented from CDPL.Grid.AttributedGrid.

Reimplemented in CDPL.Grid.FRegularGrid.