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

Public Member Functions

None __init__ ()
 Initializes the FragmentAssemblerSettings instance.
 
None __init__ (FragmentAssemblerSettings settings)
 Initializes a copy of the FragmentAssemblerSettings instance settings. More...
 
int getObjectID ()
 Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
 
FragmentAssemblerSettings assign (FragmentAssemblerSettings settings)
 Replaces the current state of self with a copy of the state of the FragmentAssemblerSettings instance settings. More...
 
None enumerateRings (bool enumerate)
 
bool enumerateRings ()
 
None setNitrogenEnumerationMode (int mode)
 
int getNitrogenEnumerationMode ()
 
None generateCoordinatesFromScratch (bool reuse)
 
bool generateCoordinatesFromScratch ()
 
FragmentConformerGeneratorSettings getFragmentBuildSettings ()
 

Static Public Attributes

 DEFAULT = _HIDDEN_VALUE_
 

Properties

 objectID = property(getObjectID)
 
 enumRings = property(enumerateRings, enumerateRings)
 
 nitrogenEnumMode = property(getNitrogenEnumerationMode, setNitrogenEnumerationMode)
 
 genCoordsFromScratch = property(generateCoordinatesFromScratch, generateCoordinatesFromScratch)
 
 fragmentBuildSettings = property(getFragmentBuildSettings)
 

Constructor & Destructor Documentation

◆ __init__()

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

Initializes a copy of the FragmentAssemblerSettings instance settings.

Parameters
settingsThe FragmentAssemblerSettings instance to copy.

Member Function Documentation

◆ getObjectID()

int CDPL.ConfGen.FragmentAssemblerSettings.getObjectID ( )

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

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

FragmentAssemblerSettings CDPL.ConfGen.FragmentAssemblerSettings.assign ( FragmentAssemblerSettings  settings)

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

Parameters
settingsThe FragmentAssemblerSettings instance to copy.
Returns
self

◆ enumerateRings() [1/2]

None CDPL.ConfGen.FragmentAssemblerSettings.enumerateRings ( bool  enumerate)
Parameters
enumerate

◆ enumerateRings() [2/2]

bool CDPL.ConfGen.FragmentAssemblerSettings.enumerateRings ( )
Returns

◆ setNitrogenEnumerationMode()

None CDPL.ConfGen.FragmentAssemblerSettings.setNitrogenEnumerationMode ( int  mode)
Parameters
mode

◆ getNitrogenEnumerationMode()

int CDPL.ConfGen.FragmentAssemblerSettings.getNitrogenEnumerationMode ( )
Returns

◆ generateCoordinatesFromScratch() [1/2]

None CDPL.ConfGen.FragmentAssemblerSettings.generateCoordinatesFromScratch ( bool  reuse)
Parameters
reuse

◆ generateCoordinatesFromScratch() [2/2]

bool CDPL.ConfGen.FragmentAssemblerSettings.generateCoordinatesFromScratch ( )
Returns

◆ getFragmentBuildSettings()

FragmentConformerGeneratorSettings CDPL.ConfGen.FragmentAssemblerSettings.getFragmentBuildSettings ( )
Returns