Skip to main content

API Reference

Auto-generated C++ API documentation from source code using Doxygen.

Namespaces

NamespaceDescription
chrononMain public API — all commonly-used types
chronon::senderCore simulation engine internals
chronon::observeObservability system (counters, traces, logs)
chronon::paramsParameter and configuration system

Core Classes

ClassHeaderDescription
TickableUnitchronon/Unit.hppBase class for tick-driven simulation units
TickSimulationchronon/Simulation.hppMain simulation engine with parallel execution
OutPort<T>chronon/Port.hppOutput port for sending data
InPort<T>chronon/Port.hppInput port for receiving data
Connection<T>chronon/Port.hppPort-to-port connection with configurable delay
Counterchronon/Observe.hppPer-unit performance counter
ObservableUnitchronon/Observe.hppMixin for units with observability
TimelineLane / TimelineCounterchronon/Observe.hppPerfetto occupancy spans and ordered push-model counter tracks
TimelineSpan / TimelineGauge / TimelineCapacitychronon/Observe.hppConvenience helpers for Perfetto events, stalls, occupancy, and free capacity
Pipeline trace primitiveschronon/Observe.hppTyped one-cycle pipeline slices for model-level observe::pipeline wrappers
Param<T>chronon/Params.hppSelf-registering parameter wrapper
SimulationAppchronon/SimulationApp.hppUnified CLI entry point

Browse

  • Namespaceschronon, chronon::sender, chronon::observe, chronon::params
  • Classes — all documented classes and structs

Single Include

#include "chronon/Chronon.hpp"
using namespace chronon;