Chemical Data Processing Library Python API - Version 1.1.1
Public Member Functions | Properties | List of all members
CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint Class Reference
+ Inheritance diagram for CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint:

Public Member Functions

None __init__ (int pt1_idx, int pt2_idx, float lb, float ub)
 Initializes the DistanceConstraint instance. More...
 
None __init__ (DistanceConstraint constr)
 Initializes a copy of the DistanceConstraint instance constr. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
DistanceConstraint assign (DistanceConstraint constr)
 Replaces the current state of self with a copy of the state of the DistanceConstraint instance constr. More...
 
int getPoint1Index ()
 
int getPoint2Index ()
 
float getLowerBound ()
 
float getUpperBound ()
 

Properties

 objectID = property(getObjectID)
 
 point1Index = property(getPoint1Index)
 
 point2Index = property(getPoint2Index)
 
 lowerBound = property(getLowerBound)
 
 upperBound = property(getUpperBound)
 

Constructor & Destructor Documentation

◆ __init__() [1/2]

None CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.__init__ ( int  pt1_idx,
int  pt2_idx,
float  lb,
float  ub 
)

Initializes the DistanceConstraint instance.

Parameters
pt1_idx
pt2_idx
lb
ub

◆ __init__() [2/2]

None CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.__init__ ( DistanceConstraint  constr)

Initializes a copy of the DistanceConstraint instance constr.

Parameters
constrThe DistanceConstraint instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.getObjectID ( )

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

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

DistanceConstraint CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.assign ( DistanceConstraint  constr)

Replaces the current state of self with a copy of the state of the DistanceConstraint instance constr.

Parameters
constrThe DistanceConstraint instance to copy.
Returns
self

◆ getPoint1Index()

int CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.getPoint1Index ( )
Returns

◆ getPoint2Index()

int CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.getPoint2Index ( )
Returns

◆ getLowerBound()

float CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.getLowerBound ( )
Returns

◆ getUpperBound()

float CDPL.Util.DG2DCoordinatesGenerator.DistanceConstraint.getUpperBound ( )
Returns