API Reference

API Reference

This section contains auto-generated API documentation for all Orix Platform products.

Products

Product	Description	Status
Atom	Foundation layer - Math, Collections, Primitives	Available
Axion	Schema language and code generation	Available
Lattice	Storage, Chronicle, and CRDT	Available
Flux	Simulation runtime and ECS	Available
Airlock	Secrets management and encryption	Available

How to Read This Documentation

• Namespaces organize types by functionality
• Classes/Structs show constructors, properties, and methods
• Interfaces define contracts implemented by types
• Enums list all possible values with descriptions

Key Types by Product

Atom (Foundation)

Type	Description
DFixed64	Q32.32 fixed-point number for deterministic math
DVector2/3/4	Deterministic vector types
UnsafeMap<K,V>	Ordered dictionary with deterministic iteration
UnsafeSet<T>	Ordered set with deterministic iteration
Entity	Unique entity identifier
Tick	Discrete time unit

Axion (Schema)

Type	Description
AxionSerializer	Binary serialization for Axion types
SchemaValidator	Runtime schema validation
AxionKeyManager	Encryption key management

Lattice (Storage)

Type	Description
Chronicle<T>	Time-travel enabled storage
LatticeDb	Main database interface
OrSet<T>, OrMap<K,V>	CRDT types for conflict-free replication

Flux (Simulation)

Type	Description
World	ECS world container
System	Base class for simulation systems
TickScheduler	Deterministic tick execution

Airlock (Secrets)

Type	Description
Vault	Secure secrets storage
FieldCrypto	Field-level encryption
SecretId	Unique secret identifier

Generated From Code

This documentation is auto-generated from XML comments in the source code using DocFX.

Regenerating Documentation

# Install DocFX (once)
dotnet tool install -g docfx

# Generate API docs
cd tools/apidocs
pwsh ./generate-api-docs.ps1

CI/CD Pipeline

API documentation is automatically regenerated when:

• C# source files change in src/**/*.cs
• DocFX configuration changes in tools/apidocs/**
• Manually triggered via workflow dispatch

See .github/workflows/api-docs.yml for the pipeline configuration.