OECSVFileConverter

Attention

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

class OECSVFileConverter

The OECSVFileConverter class extracts data from CSV and TSV files into OERecord. Custom data extraction based on delimiter type and OEField inclusion can be set up through the OECSVConversionOptions.

Constructors

OECSVFileConverter()
OECSVFileConverter(const OECSVFileConverter &)

Open

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

Returns a boolean based on whether the file can be opened. OECSVConversionOptions is set at open.

operator=

OECSVFileConverter &operator=(const OECSVFileConverter &)

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.