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
OEHelmParsingResult(arg2: OEHelmParsingResult) -> OEHelmParsingResult
Default and copy constructor.
GetCodeSet
GetCodeSet() -> str
Returns the name of the code-set that is used to successfully parse the HELM string.
GetErrorPosition
GetErrorPosition() -> int
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
GetReturnCode() -> int
Returns a code from the
OEHelmParsingReturnCode namespace.
GetWarning
GetWarning() -> str
If the HELM parsing fails, i.e. the return code is not
OEHelmParsingReturnCode_Success,
this message provides details about the reason for the failure.