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() -> OEDBReader

Default constructor.

GetFragCount

GetFragCount() -> int

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

GetIndices

GetIndices() -> OEUIntVector

Returns the database indices currently associated with this reader.

GetNextPacket

GetNextPacket(blob: OEBroodDBPacket) -> bool

Retrieves the next available database packet.

Init

Init(prefix: str, query: OEBroodQuery,
     scoreOpts: OEBroodGeneralOptions = OEBroodGeneralOptions()) -> int
Init(prefix: str, vecIdx: OEUIntVector = List[int]) -> int

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.