CDPL.ConfGen.StructureGenerator Class Reference

Inheritance diagram for CDPL.ConfGen.StructureGenerator:

Public Member Functions
None	__init__ ()
	Initializes the StructureGenerator instance.
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
StructureGeneratorSettings	getSettings ()
None	clearFragmentLibraries ()
None	addFragmentLibrary (FragmentLibrary lib)
None	clearTorsionLibraries ()
None	addTorsionLibrary (TorsionLibrary lib)
None	setAbortCallback (CallbackFunction func)
CallbackFunction	getAbortCallback ()
None	setTimeoutCallback (CallbackFunction func)
CallbackFunction	getTimeoutCallback ()
None	setLogMessageCallback (LogMessageCallbackFunction func)
LogMessageCallbackFunction	getLogMessageCallback ()
int	generate (Chem.MolecularGraph molgraph)
int	generate (Chem.MolecularGraph molgraph, Chem.MolecularGraph fixed_substr)
int	generate (Chem.MolecularGraph molgraph, Chem.MolecularGraph fixed_substr, Math.Vector3DArray fixed_substr_coords)
None	setCoordinates (Chem.MolecularGraph molgraph)
ConformerData	getCoordinates ()

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

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

addFragmentLibrary()

None CDPL.ConfGen.StructureGenerator.addFragmentLibrary

(

FragmentLibrary

lib

)

Parameters

lib

addTorsionLibrary()

None CDPL.ConfGen.StructureGenerator.addTorsionLibrary

(

TorsionLibrary

lib

)

Parameters

lib

setAbortCallback()

None CDPL.ConfGen.StructureGenerator.setAbortCallback

(

CallbackFunction

func

)

Parameters

func

getAbortCallback()

CallbackFunction CDPL.ConfGen.StructureGenerator.getAbortCallback

(

)

Returns

setTimeoutCallback()

None CDPL.ConfGen.StructureGenerator.setTimeoutCallback

(

CallbackFunction

func

)

Parameters

func

getTimeoutCallback()

CallbackFunction CDPL.ConfGen.StructureGenerator.getTimeoutCallback

(

)

Returns

setLogMessageCallback()

None CDPL.ConfGen.StructureGenerator.setLogMessageCallback

(

LogMessageCallbackFunction

func

)

Parameters

func

getLogMessageCallback()

LogMessageCallbackFunction CDPL.ConfGen.StructureGenerator.getLogMessageCallback

(

)

Returns

generate() [1/3]

int CDPL.ConfGen.StructureGenerator.generate

(

Chem.MolecularGraph

molgraph

)

Parameters

molgraph

Returns

generate() [2/3]

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

Parameters

molgraph
fixed_substr

Returns

generate() [3/3]

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

Parameters

molgraph
fixed_substr
fixed_substr_coords

Returns

setCoordinates()

None CDPL.ConfGen.StructureGenerator.setCoordinates

(

Chem.MolecularGraph

molgraph

)

Parameters

molgraph

getCoordinates()

ConformerData CDPL.ConfGen.StructureGenerator.getCoordinates

(

)

Returns