Developer Documentation

The goal of this section is to provide more background information for developers reading through the source code and making changes.

Backends

Todo

Talk here about implementing backend classes for group, intervals, and dict objects.

enum tidas::data_type

Values:

none

Undefined type.

int8

C compatible int8_t type.

uint8

C compatible uint8_t type.

int16

C compatible int16_t type.

uint16

C compatible uint16_t type.

int32

C compatible int32_t type.

uint32

C compatible uint32_t type.

int64

C compatible int64_t type.

uint64

C compatible uint64_t type.

float32

float type.

float64

double type.

string

C++ string type.

enum tidas::backend_type

Values:

none

Backend not assigned.

hdf5

HDF5 backend.

getdata

GetData backend.

enum tidas::compression_type

Values:

none

No compression.

gzip

gzip (libz) compression.

bzip2

bzip2 compression.

enum tidas::access_mode

Values:

read

Read-only access.

write

Read-write access.

Location Information

Each object has a “location” which represents its on-disk position relative to other objects in the hierarchy.

Todo

Add more details...

class tidas::backend_path

Indexing (Metadata Database)

Todo

Describe the 2 different metadata indices, how transactions are retrieved / replayed, etc.