CDPL.ConfGen.StructureGenerator Class Reference

High-level driver for the generation of a single low-energy 3D structure from a molecular graph. More...

Inheritance diagram for CDPL.ConfGen.StructureGenerator:

Public Member Functions
None	__init__ ()
	Constructs the StructureGenerator instance.
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
StructureGeneratorSettings	getSettings ()
	Returns the current generator settings (mutable). More...
None	clearFragmentLibraries ()
	Removes all configured fragment libraries.
None	addFragmentLibrary (FragmentLibrary lib)
	Adds lib to the list of fragment libraries consulted during fragment-based 3D structure generation. More...
None	clearTorsionLibraries ()
	Removes all configured torsion libraries.
None	addTorsionLibrary (TorsionLibrary lib)
	Adds lib to the list of torsion libraries consulted during torsion driving. More...
None	setAbortCallback (CallbackFunction func)
	Sets the callback invoked periodically to allow the generation to be aborted by the user. More...
CallbackFunction	getAbortCallback ()
	Returns the currently configured abort-check callback. More...
None	setTimeoutCallback (CallbackFunction func)
	Sets the callback invoked periodically to check whether the configured timeout has elapsed. More...
CallbackFunction	getTimeoutCallback ()
	Returns the currently configured timeout-check callback. More...
None	setLogMessageCallback (LogMessageCallbackFunction func)
	Sets the callback receiving log messages emitted by the generator. More...
LogMessageCallbackFunction	getLogMessageCallback ()
	Returns the currently configured log-message callback. More...
int	generate (Chem.MolecularGraph molgraph)
	Generates a single 3D structure for molgraph. More...
int	generate (Chem.MolecularGraph molgraph, Chem.MolecularGraph fixed_substr)
	Generates a single 3D structure for molgraph while keeping the substructure fixed_substr at its current 3D coordinates. More...
int	generate (Chem.MolecularGraph molgraph, Chem.MolecularGraph fixed_substr, Math.Vector3DArray fixed_substr_coords)
	Generates a single 3D structure for molgraph while keeping the substructure fixed_substr at the supplied 3D coordinates fixed_substr_coords. More...
None	setCoordinates (Chem.MolecularGraph molgraph)
	Transfers the generated 3D coordinates onto the atoms of molgraph (via Chem.set3DCoordinates). More...
ConformerData	getCoordinates ()
	Returns the conformer data produced by the most recent generate() call. More...

Properties
	objectID = property(getObjectID)
	settings = property(getSettings)
	coordinates = property(getCoordinates)
	abortCallback = property(getAbortCallback, setAbortCallback)
	timeoutCallback = property(getTimeoutCallback, setTimeoutCallback)
	logMessageCallback = property(getLogMessageCallback, setLogMessageCallback)

Detailed Description

High-level driver for the generation of a single low-energy 3D structure from a molecular graph.

Internally delegates to the same pipeline as class ConfGen.ConformerGenerator but stops after the first acceptable conformer has been produced.

Member Function Documentation

getObjectID()

int CDPL.ConfGen.StructureGenerator.getObjectID

(

)

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

Different Python StructureGenerator 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 StructureGenerator 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.

getSettings()

StructureGeneratorSettings CDPL.ConfGen.StructureGenerator.getSettings

(

)

Returns the current generator settings (mutable).

Returns

A reference to the settings.

addFragmentLibrary()

None CDPL.ConfGen.StructureGenerator.addFragmentLibrary

(

FragmentLibrary

lib

)

Adds lib to the list of fragment libraries consulted during fragment-based 3D structure generation.

Parameters

lib	The fragment library to add.

addTorsionLibrary()

None CDPL.ConfGen.StructureGenerator.addTorsionLibrary

(

TorsionLibrary

lib

)

Adds lib to the list of torsion libraries consulted during torsion driving.

Parameters

lib	The torsion library to add.

setAbortCallback()

None CDPL.ConfGen.StructureGenerator.setAbortCallback

(

CallbackFunction

func

)

Sets the callback invoked periodically to allow the generation to be aborted by the user.

Parameters

func	The abort-check callback.

getAbortCallback()

CallbackFunction CDPL.ConfGen.StructureGenerator.getAbortCallback

(

)

Returns the currently configured abort-check callback.

Returns

A reference to the abort-check callback.

setTimeoutCallback()

None CDPL.ConfGen.StructureGenerator.setTimeoutCallback

(

CallbackFunction

func

)

Sets the callback invoked periodically to check whether the configured timeout has elapsed.

Parameters

func	The timeout-check callback.

getTimeoutCallback()

CallbackFunction CDPL.ConfGen.StructureGenerator.getTimeoutCallback

(

)

Returns the currently configured timeout-check callback.

Returns

A reference to the timeout-check callback.

setLogMessageCallback()

None CDPL.ConfGen.StructureGenerator.setLogMessageCallback

(

LogMessageCallbackFunction

func

)

Sets the callback receiving log messages emitted by the generator.

Parameters

func	The log-message callback.

getLogMessageCallback()

LogMessageCallbackFunction CDPL.ConfGen.StructureGenerator.getLogMessageCallback

(

)

Returns the currently configured log-message callback.

Returns

A reference to the log-message callback.

generate() [1/3]

int CDPL.ConfGen.StructureGenerator.generate

(

Chem.MolecularGraph

molgraph

)

Generates a single 3D structure for molgraph.

Parameters

molgraph

The input molecular graph.

Returns

A ConfGen.ReturnCode value reporting the outcome of the generation.

generate() [2/3]

int CDPL.ConfGen.StructureGenerator.generate	(	Chem.MolecularGraph	molgraph,
		Chem.MolecularGraph	fixed_substr
	)

Generates a single 3D structure for molgraph while keeping the substructure fixed_substr at its current 3D coordinates.

Parameters

molgraph	The input molecular graph.
fixed_substr	The substructure that must retain its current 3D coordinates.

Returns

A ConfGen.ReturnCode value reporting the outcome of the generation.

Since

1.1

generate() [3/3]

int CDPL.ConfGen.StructureGenerator.generate	(	Chem.MolecularGraph	molgraph,
		Chem.MolecularGraph	fixed_substr,
		Math.Vector3DArray	fixed_substr_coords
	)

Generates a single 3D structure for molgraph while keeping the substructure fixed_substr at the supplied 3D coordinates fixed_substr_coords.

Parameters

molgraph	The input molecular graph.
fixed_substr	The substructure that must retain the supplied 3D coordinates.
fixed_substr_coords	The 3D coordinates assigned to fixed_substr.

Returns

A ConfGen.ReturnCode value reporting the outcome of the generation.

Since

1.1

setCoordinates()

None CDPL.ConfGen.StructureGenerator.setCoordinates

(

Chem.MolecularGraph

molgraph

)

Transfers the generated 3D coordinates onto the atoms of molgraph (via Chem.set3DCoordinates).

Parameters

molgraph

The molecular graph receiving the 3D coordinates.

getCoordinates()

ConformerData CDPL.ConfGen.StructureGenerator.getCoordinates

(

)

Returns the conformer data produced by the most recent generate() call.

Returns

A reference to the conformer data.