Chemical Data Processing Library Python API - Version 1.1.1
|
RegularGridSet. More...
Public Member Functions | |
None | __init__ () |
Initializes the FRegularGridSet instance. | |
None | __init__ (FRegularGridSet set) |
Initializes a copy of the FRegularGridSet instance set. More... | |
int | getObjectID () |
Returns the numeric identifier (ID) of the wrapped C++ class instance. More... | |
int | getSize () |
bool | isEmpty () |
None | resize (int num_elem, FRegularGrid value) |
None | reserve (int num_elem) |
int | getCapacity () |
None | clear () |
FRegularGridSet | assign (FRegularGridSet array) |
Replaces the current state of self with a copy of the state of the FRegularGridSet instance array. More... | |
None | assign (int num_elem, FRegularGrid value) |
None | addElement (FRegularGrid value) |
None | addElements (FRegularGridSet values) |
None | insertElement (int idx, FRegularGrid value) |
None | insertElements (int idx, int num_elem, FRegularGrid value) |
None | insertElements (int index, FRegularGridSet values) |
None | popLastElement () |
None | removeElement (int idx) |
None | removeElements (int begin_idx, int end_idx) |
FRegularGrid | getFirstElement () |
FRegularGrid | getLastElement () |
FRegularGrid | getElement (int idx) |
None | setElement (int idx, FRegularGrid value) |
None | __delitem__ (int idx) |
FRegularGrid | __getitem__ (int idx) |
int | __len__ () |
None | __setitem__ (int index, FRegularGrid value) |
bool | __eq__ (object set) |
Returns the result of the comparison operation self == set . More... | |
bool | __ne__ (object set) |
Returns the result of the comparison operation self != set . More... | |
Properties | |
objectID = property(getObjectID) | |
size = property(getSize) | |
RegularGridSet.
None CDPL.Grid.FRegularGridSet.__init__ | ( | FRegularGridSet | set | ) |
Initializes a copy of the FRegularGridSet instance set.
set | The FRegularGridSet instance to copy. |
int CDPL.Grid.FRegularGridSet.getObjectID | ( | ) |
Returns the numeric identifier (ID) of the wrapped C++ class instance.
Different Python FRegularGridSet instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b
thus cannot tell reliably whether the two FRegularGridSet instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID()
.
int CDPL.Grid.FRegularGridSet.getSize | ( | ) |
bool CDPL.Grid.FRegularGridSet.isEmpty | ( | ) |
None CDPL.Grid.FRegularGridSet.resize | ( | int | num_elem, |
FRegularGrid | value | ||
) |
num_elem | |
value |
None CDPL.Grid.FRegularGridSet.reserve | ( | int | num_elem | ) |
num_elem |
int CDPL.Grid.FRegularGridSet.getCapacity | ( | ) |
FRegularGridSet CDPL.Grid.FRegularGridSet.assign | ( | FRegularGridSet | array | ) |
Replaces the current state of self with a copy of the state of the FRegularGridSet instance array.
array | The FRegularGridSet instance to copy. |
None CDPL.Grid.FRegularGridSet.assign | ( | int | num_elem, |
FRegularGrid | value | ||
) |
num_elem | |
value |
None CDPL.Grid.FRegularGridSet.addElement | ( | FRegularGrid | value | ) |
value |
None CDPL.Grid.FRegularGridSet.addElements | ( | FRegularGridSet | values | ) |
values |
None CDPL.Grid.FRegularGridSet.insertElement | ( | int | idx, |
FRegularGrid | value | ||
) |
idx | |
value |
None CDPL.Grid.FRegularGridSet.insertElements | ( | int | idx, |
int | num_elem, | ||
FRegularGrid | value | ||
) |
idx | |
num_elem | |
value |
None CDPL.Grid.FRegularGridSet.insertElements | ( | int | index, |
FRegularGridSet | values | ||
) |
index | |
values |
None CDPL.Grid.FRegularGridSet.removeElement | ( | int | idx | ) |
idx |
None CDPL.Grid.FRegularGridSet.removeElements | ( | int | begin_idx, |
int | end_idx | ||
) |
begin_idx | |
end_idx |
FRegularGrid CDPL.Grid.FRegularGridSet.getFirstElement | ( | ) |
FRegularGrid CDPL.Grid.FRegularGridSet.getLastElement | ( | ) |
FRegularGrid CDPL.Grid.FRegularGridSet.getElement | ( | int | idx | ) |
idx |
None CDPL.Grid.FRegularGridSet.setElement | ( | int | idx, |
FRegularGrid | value | ||
) |
idx | |
value |
None CDPL.Grid.FRegularGridSet.__delitem__ | ( | int | idx | ) |
idx |
FRegularGrid CDPL.Grid.FRegularGridSet.__getitem__ | ( | int | idx | ) |
idx |
int CDPL.Grid.FRegularGridSet.__len__ | ( | ) |
None CDPL.Grid.FRegularGridSet.__setitem__ | ( | int | index, |
FRegularGrid | value | ||
) |
index | |
value |
bool CDPL.Grid.FRegularGridSet.__eq__ | ( | object | set | ) |
Returns the result of the comparison operation self == set
.
set | The object instance to be compared with. |
bool CDPL.Grid.FRegularGridSet.__ne__ | ( | object | set | ) |
Returns the result of the comparison operation self != set
.
set | The object instance to be compared with. |