OEDUFileConverter

Attention

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

class OEDUFileConverter

The OEDUFileConverter class extracts the OEDesignUnit from an OEDU file into OERecord. The Iridium category is determined by each OERecord extracted.

Constructors

OEDUFileConverter() -> OEDUFileConverter
OEDUFileConverter(arg2: OEDUFileConverter) -> OEDUFileConverter

Open

Open(path: str, displayName: str = str()) -> bool

Returns a boolean based on whether the file can be opened.

Close

Close() -> None

Closes the stream.

GetNextRecord

GetNextRecord(record: OEMolRecord) -> int

Steps through each row of the file adding to the OEMolRecord passed into the function. The function returns constants based on each pass. Return codes: SaiphReturnCode::Success, SaiphReturnCode::Fail, SaiphReturnCode::EndOfFile

GetProgress

GetProgress() -> float

Returns the percentage of the file that has been traversed.