DataLayerGenerator

Getting Started

  • The Basics
    • Overview
    • Architecture
    • C++ Framework API
      • GroupInfo
        • DataLayer::GroupInfo
      • DataPoint
      • GroupDataPointMapping
        • DataLayer::GroupDataPointMapping
      • Dispatcher
        • DataLayer::Dispatcher

Model File Reference

  • Model File Reference
    • groups.json
    • datapoints.json
    • structs.json
    • enums.json
    • types.json
    • YAML Support

Code Generator

  • Code Generator
    • Requirements
    • Invocation
    • Output Files
    • CMake Integration
    • Validation
    • Templates

C++ API Reference

  • Helper Types
    • Version
      • Version
    • FixedString
      • FixedString
    • PersistenceType
      • PersistenceType
        • None
        • Cyclic
        • OnWrite
    • Access Tag Types
      • Helper::READ_ONLY
      • Helper::WRITE_ONLY
      • Helper::READ_WRITE
    • BaseType
      • DataLayer::Detail::BaseType
    • CheckResult
      • DataLayer::Detail::CheckResult
    • Helper Utilities
      • make_array()
      • checkValue()
  • C++20 Concepts
    • Access Concepts
    • Type Concepts
      • IsArray
      • IsContainer
      • IsString
    • Range Concept
      • hasRange
  • Enumerations
    • Framework Enumerations
      • RangeCheck
        • RangeCheck
      • PersistenceType
        • PersistenceType
      • SerializationError
        • SerializationError
    • Model-Defined Enumerations
  • File Persistence (Serialization)
    • Enabling Persistence
    • Version-Aware Upgrade
    • API Reference
      • SerializationStatus
      • SerializationError
        • None
        • GroupVersion
        • DatapointVersion
        • GroupAndDatapointVersion
        • NotAllBytesRead
      • Serialization
      • Deserialization

Packaging & Integration

  • Packaging & Integration
    • Installing the Package from Source
    • Conan Options
    • CMake Integration for Consumers
    • Building the Documentation
    • Cross-Compilation (ARM Cortex-M4)

Examples

  • Examples
    • Reading and Writing a Datapoint
    • Range-Checked Alias Types
    • Struct Datapoints
    • Array Datapoints
    • Dispatcher — Runtime-ID Access
    • Printing the Data Layer Structure
    • File Persistence
    • Python Bindings
DataLayerGenerator
  • Index

Index

D | F | H | I | S | V

D

  • DataLayer::Detail::BaseType (C++ struct)
  • DataLayer::Detail::CheckResult (C++ struct)
  • DataLayer::Detail::checkValue (C++ function)
  • DataLayer::Detail::hasRange (C++ concept)
  • DataLayer::Detail::IsArray (C++ concept)
  • DataLayer::Detail::make_array (C++ function)
  • DataLayer::Detail::RangeCheck (C++ enum)
  • DataLayer::Detail::RangeCheck::notChecked (C++ enumerator)
  • DataLayer::Detail::RangeCheck::ok (C++ enumerator)
  • DataLayer::Detail::RangeCheck::overflow (C++ enumerator)
  • DataLayer::Detail::RangeCheck::underflow (C++ enumerator)
  • DataLayer::Dispatcher (C++ struct)
  • DataLayer::GroupDataPointMapping (C++ struct)
  • DataLayer::GroupInfo (C++ struct)
  • DataLayer::PersistenceType (C++ enum), [1]
  • DataLayer::PersistenceType::Cyclic (C++ enumerator), [1]
  • DataLayer::PersistenceType::None (C++ enumerator), [1]
  • DataLayer::PersistenceType::OnWrite (C++ enumerator), [1]
  • Deserialization (C++ struct)

F

  • FixedString (C++ struct)

H

  • Helper::READ_ONLY (C++ struct)
  • Helper::READ_WRITE (C++ struct)
  • Helper::WRITE_ONLY (C++ struct)

I

  • IsContainer (C++ concept)
  • IsString (C++ concept)

S

  • Serialization (C++ struct)
  • SerializationError (C++ enum), [1]
  • SerializationError::DatapointVersion (C++ enumerator), [1]
  • SerializationError::GroupAndDatapointVersion (C++ enumerator), [1]
  • SerializationError::GroupVersion (C++ enumerator), [1]
  • SerializationError::None (C++ enumerator), [1]
  • SerializationError::NotAllBytesRead (C++ enumerator), [1]
  • SerializationStatus (C++ struct)

V

  • Version (C++ struct)

© Copyright 2025, Kantelberg Stephan.

Built with Sphinx using a theme provided by Read the Docs.