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

Data structure storing a set of (shared) Gaussian shapes. More...

+ Inheritance diagram for CDPL.Shape.GaussianShapeSet:

Public Member Functions

None __init__ ()
 Initializes the GaussianShapeSet instance.
 
None __init__ (GaussianShapeSet list)
 Initializes a copy of the GaussianShapeSet 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, GaussianShape value)
 
None reserve (int num_elem)
 
int getCapacity ()
 
None clear ()
 
GaussianShapeSet assign (GaussianShapeSet array)
 Replaces the current state of self with a copy of the state of the GaussianShapeSet instance array. More...
 
None assign (int num_elem, GaussianShape value)
 
None addElement (GaussianShape value)
 
None addElements (GaussianShapeSet values)
 
None insertElement (int idx, GaussianShape value)
 
None insertElements (int idx, int num_elem, GaussianShape value)
 
None insertElements (int index, GaussianShapeSet values)
 
None popLastElement ()
 
None removeElement (int idx)
 
None removeElements (int begin_idx, int end_idx)
 
GaussianShape getFirstElement ()
 
GaussianShape getLastElement ()
 
GaussianShape getElement (int idx)
 
None setElement (int idx, GaussianShape value)
 
None __delitem__ (int idx)
 
GaussianShape __getitem__ (int idx)
 
int __len__ ()
 
None __setitem__ (int index, GaussianShape 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...
 

Properties

 objectID = property(getObjectID)
 
 size = property(getSize)
 

Detailed Description

Data structure storing a set of (shared) Gaussian shapes.

GaussianShapeSet is an indirect array of Shape.GaussianShape smart references, typically used as input to alignment / overlap routines that operate on multiple shapes at once.

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Shape.GaussianShapeSet.__init__ ( GaussianShapeSet  list)

Initializes a copy of the GaussianShapeSet instance list.

Parameters
listThe GaussianShapeSet instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Shape.GaussianShapeSet.getObjectID ( )

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python GaussianShapeSet 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 GaussianShapeSet 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().

Returns
The numeric ID of the internally referenced C++ class instance.

◆ assign()

GaussianShapeSet CDPL.Shape.GaussianShapeSet.assign ( GaussianShapeSet  array)

Replaces the current state of self with a copy of the state of the GaussianShapeSet instance array.

Parameters
arrayThe GaussianShapeSet instance to copy.
Returns
self

◆ __eq__()

bool CDPL.Shape.GaussianShapeSet.__eq__ ( object  list)

Returns the result of the comparison operation self == list.

Parameters
listThe object instance to be compared with.
Returns
The result of the comparison operation.

◆ __ne__()

bool CDPL.Shape.GaussianShapeSet.__ne__ ( object  list)

Returns the result of the comparison operation self != list.

Parameters
listThe object instance to be compared with.
Returns
The result of the comparison operation.