OEDBReader

Attention

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

class OEDBReader

This class defines an interface for accessing a Brood fragment database from disk.

The OEDBReader class defines the following public methods:

• GetFragCount

• GetIndices

• GetNextPacket

• Init

Constructors

OEDBReader()

Default constructor.

GetFragCount

unsigned GetFragCount() const

Returns the number of fragments in the database currently associated with this reader.

GetIndices

const std::vector<unsigned>& GetIndices() const

Returns the database indices currently associated with this reader.

GetNextPacket

bool GetNextPacket(OEBroodDBPacket&)

Retrieves the next available database packet.

Init

unsigned Init(const std::string& prefix, OEBroodQuery& query,
              const OEBroodGeneralOptions& generalOpts = OEBroodGeneralOptions())
unsigned Init(const std::string& prefix,
              const std::vector<unsigned>& vecIdx = std::vector<unsigned>());

Initializes the reader using the database specified by prefix. The first overload configures loading for packets from the specified database indices. The second overload determines relevant indices from the provided query and general options, then configures loading for those packets. Returns OEBroodStatusCode::Success if initialization is successful, otherwise an error code from OEBroodStatusCode.