OEHelmParsingResult

Attention

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

class OEHelmParsingResult

This class is used to return additional information when using the OEHelmToMol function.

Constructors

OEHelmParsingResult()
OEHelmParsingResult(const OEHelmParsingResult &)

Default and copy constructor.

operator=

OEHelmParsingResult &operator=(const OEHelmParsingResult &)

Assignment operator.

GetCodeSet

std::string GetCodeSet() const

Returns the name of the code-set that is used to successfully parse the HELM string.

GetErrorPosition

unsigned GetErrorPosition() const

If the HELm parsing fails, i.e. the return code is not OEHelmParsingReturnCode::Success, this shows the position in the HELM string where the failure occurs.

GetReturnCode

unsigned GetReturnCode() const

Returns a code from the OEHelmParsingReturnCode namespace.

GetWarning

std::string GetWarning() const

If the HELM parsing fails, i.e. the return code is not OEHelmParsingReturnCode::Success, this message provides details about the reason for the failure.