OEMolDatabaseSaveOptions

class OEMolDatabaseSaveOptions

The class used to contain additional options for the OEMolDatabase.Save method.

Constructors

OEMolDatabaseSaveOptions() -> OEMolDatabaseSaveOptions
OEMolDatabaseSaveOptions(format: int, flavor: int, writeIdx: bool,
                         idxFileName: str) -> OEMolDatabaseSaveOptions

The default constructor initializes the object to the following:

format OEFormat_UNDEFINED

flavor 0

writeIdx true

idxFileName Empty string

GetFlavor

GetFlavor() -> int

Returns a constant from the OEOFlavor namespace for the format being saved to.

GetFormat

GetFormat() -> int

Returns a constant from the the OEFormat namespace namespace.

GetIdxFileName

GetIdxFileName() -> str

Returns the name of the index file being written to. If this file name is empty and OEMolDatabaseSaveOptions.GetWriteIdx returns true, the file name will be automatically determined with the same rules as OEGetMolDatabaseIdxFileName.

GetWriteIdx

GetWriteIdx() -> bool

Returns whether an index file should be created as well.

SetFlavor

SetFlavor(flvr: int) -> None

Specifies what the file format flavor the database should be saved to. flvr should be a value from the OEOFlavor namespace.

SetFormat

SetFormat(fmt: int) -> None

Specifies what file format the database should be saved to. fmt should be a value from the the OEFormat namespace.

SetIdxFileName

SetIdxFileName(f: str) -> None

Specifies what the index file name should be.

SetWriteIdx

SetWriteIdx(w: bool) -> None

Specifies whether an index file should be created during the database save operation.