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(const OEDUFileConverter &)

Open

bool Open(const std::string &path,
          const std::string &displayName=std::string()) override

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

operator=

OEDUFileConverter &operator=(const OEDUFileConverter &)

Close

void Close()

Closes the stream.

GetNextRecord

unsigned int GetNextRecord(OEDataFlow::OEMolRecord &record) override

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

float GetProgress()

Returns the percentage of the file that has been traversed.