Chemical Data Processing Library Python API - Version 1.2.0
Public Member Functions | Static Public Attributes | Properties | List of all members
CDPL.ConfGen.DGConstraintGeneratorSettings Class Reference
+ Inheritance diagram for CDPL.ConfGen.DGConstraintGeneratorSettings:

Public Member Functions

None __init__ ()
 Initializes the DGConstraintGeneratorSettings instance.
 
None __init__ (DGConstraintGeneratorSettings settings)
 Initializes a copy of the DGConstraintGeneratorSettings instance settings. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
DGConstraintGeneratorSettings assign (DGConstraintGeneratorSettings settings)
 Replaces the current state of self with a copy of the state of the DGConstraintGeneratorSettings instance settings. More...
 
None excludeHydrogens (bool exclude)
 
bool excludeHydrogens ()
 
None regardAtomConfiguration (bool regard)
 
bool regardAtomConfiguration ()
 
None regardBondConfiguration (bool regard)
 
bool regardBondConfiguration ()
 

Static Public Attributes

 DEFAULT = _HIDDEN_VALUE_
 

Properties

 objectID = property(getObjectID)
 
 exclHydrogens = property(excludeHydrogens, excludeHydrogens)
 
 regardAtomConfig = property(regardAtomConfiguration, regardAtomConfiguration)
 
 regardBondConfig = property(regardBondConfiguration, regardBondConfiguration)
 

Constructor & Destructor Documentation

◆ __init__()

None CDPL.ConfGen.DGConstraintGeneratorSettings.__init__ ( DGConstraintGeneratorSettings  settings)

Initializes a copy of the DGConstraintGeneratorSettings instance settings.

Parameters
settingsThe DGConstraintGeneratorSettings instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.ConfGen.DGConstraintGeneratorSettings.getObjectID ( )

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

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

DGConstraintGeneratorSettings CDPL.ConfGen.DGConstraintGeneratorSettings.assign ( DGConstraintGeneratorSettings  settings)

Replaces the current state of self with a copy of the state of the DGConstraintGeneratorSettings instance settings.

Parameters
settingsThe DGConstraintGeneratorSettings instance to copy.
Returns
self

Reimplemented in CDPL.ConfGen.DGStructureGeneratorSettings.

◆ excludeHydrogens() [1/2]

None CDPL.ConfGen.DGConstraintGeneratorSettings.excludeHydrogens ( bool  exclude)
Parameters
exclude

◆ excludeHydrogens() [2/2]

bool CDPL.ConfGen.DGConstraintGeneratorSettings.excludeHydrogens ( )
Returns

◆ regardAtomConfiguration() [1/2]

None CDPL.ConfGen.DGConstraintGeneratorSettings.regardAtomConfiguration ( bool  regard)
Parameters
regard

◆ regardAtomConfiguration() [2/2]

bool CDPL.ConfGen.DGConstraintGeneratorSettings.regardAtomConfiguration ( )
Returns

◆ regardBondConfiguration() [1/2]

None CDPL.ConfGen.DGConstraintGeneratorSettings.regardBondConfiguration ( bool  regard)
Parameters
regard

◆ regardBondConfiguration() [2/2]

bool CDPL.ConfGen.DGConstraintGeneratorSettings.regardBondConfiguration ( )
Returns