Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Properties | List of all members
CDPL.Chem.Atom3DCoordinatesFunctor Class Reference

Atom3DCoordinatesFunctor. More...

+ Inheritance diagram for CDPL.Chem.Atom3DCoordinatesFunctor:

Public Member Functions

None __init__ (Atom3DCoordinatesFunctor func)
 Initializes a copy of the Atom3DCoordinatesFunctor instance func. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
Atom3DCoordinatesFunctor assign (Atom3DCoordinatesFunctor func)
 Replaces the current state of self with a copy of the state of the Atom3DCoordinatesFunctor instance func. More...
 
Math.Vector3D __call__ (Atom atom)
 Returns the 3D-coordinates of the argument atom. More...
 

Properties

 objectID = property(getObjectID)
 

Detailed Description

Atom3DCoordinatesFunctor.

Constructor & Destructor Documentation

◆ __init__()

None CDPL.Chem.Atom3DCoordinatesFunctor.__init__ ( Atom3DCoordinatesFunctor  func)

Initializes a copy of the Atom3DCoordinatesFunctor instance func.

Parameters
funcThe Atom3DCoordinatesFunctor instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Chem.Atom3DCoordinatesFunctor.getObjectID ( )

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

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

Atom3DCoordinatesFunctor CDPL.Chem.Atom3DCoordinatesFunctor.assign ( Atom3DCoordinatesFunctor  func)

Replaces the current state of self with a copy of the state of the Atom3DCoordinatesFunctor instance func.

Parameters
funcThe Atom3DCoordinatesFunctor instance to copy.
Returns
self

◆ __call__()

Math.Vector3D CDPL.Chem.Atom3DCoordinatesFunctor.__call__ ( Atom  atom)

Returns the 3D-coordinates of the argument atom.

Parameters
atomThe atom.
Returns
The 3D-coordinates of the atom.
See also
Chem.get3DCoordinates(const Atom&)