OEMolDatabaseSaveOptions

class OEMolDatabaseSaveOptions

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

Constructors

OEMolDatabaseSaveOptions()
OEMolDatabaseSaveOptions(unsigned int format, unsigned int flavor, bool writeIdx,
                         const std::string &idxFileName)

The default constructor initializes the object to the following:

format OEFormat::UNDEFINED

flavor 0

writeIdx true

idxFileName Empty string

GetFlavor

unsigned int GetFlavor() const

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

GetFormat

unsigned int GetFormat() const

Returns a constant from the the OEFormat namespace namespace.

GetIdxFileName

const std::string &GetIdxFileName() const

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

bool GetWriteIdx() const

Returns whether an index file should be created as well.

SetFlavor

void SetFlavor(unsigned int flvr)

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

SetFormat

void SetFormat(unsigned int fmt)

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

SetIdxFileName

void SetIdxFileName(const std::string &f)

Specifies what the index file name should be.

SetWriteIdx

void SetWriteIdx(bool w)

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