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

Public Member Functions

None __init__ ()
 Initializes the DGStructureGeneratorSettings instance.
 
None __init__ (DGStructureGeneratorSettings settings)
 Initializes a copy of the DGStructureGeneratorSettings instance settings. More...
 
DGStructureGeneratorSettings assign (DGStructureGeneratorSettings settings)
 Replaces the current state of self with a copy of the state of the DGStructureGeneratorSettings instance settings. More...
 
DGStructureGeneratorSettings assign (DGConstraintGeneratorSettings settings)
 Replaces the current state of self with a copy of the state of the DGConstraintGeneratorSettings instance settings. More...
 
None setBoxSize (float size)
 
float getBoxSize ()
 
None enablePlanarityConstraints (bool enable)
 
bool enablePlanarityConstraints ()
 
- Public Member Functions inherited from CDPL.ConfGen.DGConstraintGeneratorSettings
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...
 
None excludeHydrogens (bool exclude)
 
bool excludeHydrogens ()
 
None regardAtomConfiguration (bool regard)
 
bool regardAtomConfiguration ()
 
None regardBondConfiguration (bool regard)
 
bool regardBondConfiguration ()
 

Static Public Attributes

 DEFAULT_ = _HIDDEN_VALUE_
 
- Static Public Attributes inherited from CDPL.ConfGen.DGConstraintGeneratorSettings
 DEFAULT = _HIDDEN_VALUE_
 

Properties

 boxSize = property(getBoxSize, setBoxSize)
 
 planarityConstraints = property(enablePlanarityConstraints, enablePlanarityConstraints)
 
- Properties inherited from CDPL.ConfGen.DGConstraintGeneratorSettings
 objectID = property(getObjectID)
 
 exclHydrogens = property(excludeHydrogens, excludeHydrogens)
 
 regardAtomConfig = property(regardAtomConfiguration, regardAtomConfiguration)
 
 regardBondConfig = property(regardBondConfiguration, regardBondConfiguration)
 

Constructor & Destructor Documentation

◆ __init__()

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

Initializes a copy of the DGStructureGeneratorSettings instance settings.

Parameters
settingsThe DGStructureGeneratorSettings instance to copy.

Member Function Documentation

◆ assign() [1/2]

DGStructureGeneratorSettings CDPL.ConfGen.DGStructureGeneratorSettings.assign ( DGStructureGeneratorSettings  settings)

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

Parameters
settingsThe DGStructureGeneratorSettings instance to copy.
Returns
self

◆ assign() [2/2]

DGStructureGeneratorSettings CDPL.ConfGen.DGStructureGeneratorSettings.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 from CDPL.ConfGen.DGConstraintGeneratorSettings.

◆ setBoxSize()

None CDPL.ConfGen.DGStructureGeneratorSettings.setBoxSize ( float  size)
Parameters
size

◆ getBoxSize()

float CDPL.ConfGen.DGStructureGeneratorSettings.getBoxSize ( )
Returns

◆ enablePlanarityConstraints() [1/2]

None CDPL.ConfGen.DGStructureGeneratorSettings.enablePlanarityConstraints ( bool  enable)
Parameters
enable

◆ enablePlanarityConstraints() [2/2]

bool CDPL.ConfGen.DGStructureGeneratorSettings.enablePlanarityConstraints ( )
Returns