OEMolToHelm

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

std::string OEMolToHelm(const OEMolBase& mol,
                        const OEMonomerSet& monomers)
std::string OEMolToHelm(const OEMolBase& mol,
                        const OEMonomerSet& monomers,
                        OEHelmGenerationResult& result)
std::string OEMolToHelm(const OEMolBase& mol,
                        const OEMonomerSet& monomers,
                        const OEHelmGenerationOptions& options)
std::string OEMolToHelm(const OEMolBase& mol,
                        const OEMonomerSet& monomers,
                        const OEHelmGenerationOptions& options,
                        OEHelmGenerationResult& result)

Converts a molecule into HELM string. The function will return HELM string if it can be generated successfully, otherwise the function will return an empty string.

mol

The molecule (OEMolBase) the HELM string is generated from.

monomers

The monomer set (OEMonomerSet) that stores the monomers that are used to generate the HELM string.

If the given monomer set supports multiple code sets, OEHelmToMol automatically selects the primary code set.

options

The options for HELM generation (OEHelmGenerationOptions).

result

Is specified, the OEHelmGenerationResult object will store additional information about the success or failure of the HELM generation.

Example