# dev4agriculture/isoxml-dotnet architecture

> Architecture diagram of the GitHub repository dev4agriculture/isoxml-dotnet, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dev4agriculture/isoxml-dotnet
- Repository: https://github.com/dev4agriculture/isoxml-dotnet

## Overview

##### Project Type and Purpose
- This is a .NET class-library toolset (“isoxml.net”) focused on parsing, generating, and manipulating agricultural ISOXML data (ISO11783-10).
- It consists of four subprojects:
- Generation CLI (autogenerates C# classes from XSDs)
- Core Library (the actual ISOXML API)
- Examples console app
- Unit Tests

##### File Structure
- Top‐level solution file (isoxml_dotnet.sln).
- Subprojects under folders:
- Dev4Agriculture.ISO11783.ISOXML.Generation
- Dev4Agriculture.ISO11783.ISOXML (core)
- Dev4Agriculture.ISO11783.ISOXML.Example
- Dev4Agriculture.ISO11783.ISOXML.Test
- Core has logical subfolders reflecting architectural layers/modules:
- Analysis, Converters, DTO, Emulator, Exceptions, Geometry, ISOExtensions, IdHandling, Messaging, Serializer, TimeLog, Utils, _generated.
- Build/CI config under .github/workflows; Directory.Build.props holds shared props.

##### Key Insights from README
- “Generation” project reads XSD files (resources/xsd) and a text template (resources/txt) to generate classes under _generated.
- Core Library exposes a main ISOXML class that loads/saves TaskDataSets (XML folders or ZIP) using Serializer; it holds Data, Grids, TimeLogs, IdTable, LinkList, Messages.
- Library published via NuGet.

##### Main Components & How to Represent Them
1. XSD Schema Repository (resources/xsd)
2. Generation CLI
3. Generated Code (_generated folder)
4. Core Library Modules:
– Serializer
– Converters & DTOs
– Analysis & Geometry
– Messaging & Exceptions
– IdHandling & ISOExtensions
– TaskController Emulator
– Utils
5. API Surface (ISOXML class)
6. Consumers:
– Examples App
– Unit Tests
– External Users via NuGet
– XSD Schemas → Generation CLI → Generated Code → Compiled into Core Library
– Core Library modules interconnect (e.g., Serializer uses Converters, DTOs, Extensions; Analysis uses Geometry; ISOXML orchestrates them all)
– ISOXML API → Consumers (Examples, Tests, NuGet clients)
c. Architectural Patterns/Principles:
– Modular layering: separation of concerns by feature area (Serialization, Conversion, Analysis, etc.)
– Code-generation step isolates schema changes from business logic.
– Core class ISOXML acts as a Facade API.
– Extensions/Converters follow Visitor/Provider patterns for flexibility.
d. Technologies/Frameworks:
– .NET (C#) projects (.csproj)
– XSD → C# generation via custom CLI (Generation)
– Unit testing via xUnit/MSTest (Test project)
– CI via GitHub Actions (.github/workflows)

##### Diagramming Recommendations
- Blue for Generation pipeline
- Green for Core Library modules
- Gray for external consumers
- One from “XSD Schema Store” to “Generation CLI”
- From “Generation CLI” to “_generated Code”
- From every Core module into “ISOXML Facade”
- From “ISOXML Facade” outward to “Examples App”, “Unit Tests”, “NuGet Clients”

##### Essential Architectural Elements to Capture
- The two-step build: Generation → Compilation of Core
- The modular composition of Core Library
- The ISOXML API as Facade
- External usage via CLI Example, Tests, and client libraries
- Data flow:
1. Load folder/ZIP → Serializer parses XML → DTOs ← Converters/Extensions
2. Analysis/Geometry modules operate on DTOs
3. Results/Errors collected in Messaging
4. Save back via Serializer

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Generation Pipeline
    subgraph "Generation Pipeline"
        XSD["XSD Schema Repository"]:::generation
        GenCLI["Generation CLI"]:::generation
        GenCode["_generated Code"]:::generation
    end
    XSD -->|reads XSD files| GenCLI
    GenCLI -->|generates C# classes| GenCode
    GenCode -->|compiled into| CoreLibrary

    %% Core Library
    subgraph "Core Library"
        CoreLibrary["Dev4Agriculture.ISO11783.ISOXML.csproj"]:::core

        subgraph Modules
            Serializer["Serializer Module"]:::core
            Converters["Converters Module"]:::core
            DTOs["DTOs Module"]:::core
            Analysis["Analysis Module"]:::core
            Geometry["Geometry Module"]:::core
            Messaging["Messaging Module"]:::core
            Exceptions["Exceptions Module"]:::core
            IdHandling["IdHandling Module"]:::core
            ISOExtensions["ISOExtensions Module"]:::core
            Emulator["TaskController Emulator"]:::core
            Utils["Utils Module"]:::core
        end

        ISOXML["ISOXML Facade API"]:::core
    end

    %% Module Interactions
    Serializer -->|uses| Converters
    Serializer -->|uses| DTOs
    Serializer -->|uses| ISOExtensions
    Analysis -->|uses| Geometry
    Converters -->|produce data for| DTOs
    ISOXML -->|orchestrates| Serializer
    ISOXML -->|orchestrates| Converters
    ISOXML -->|orchestrates| DTOs
    ISOXML -->|orchestrates| Analysis
    ISOXML -->|orchestrates| Geometry
    ISOXML -->|orchestrates| Messaging
    ISOXML -->|orchestrates| Exceptions
    ISOXML -->|orchestrates| IdHandling
    ISOXML -->|orchestrates| ISOExtensions
    ISOXML -->|orchestrates| Emulator
    ISOXML -->|orchestrates| Utils

    %% Consumers
    subgraph "Consumers"
        ExampleApp["Examples App"]:::consumer
        UnitTests["Unit Tests"]:::consumer
        NuGetClients["External NuGet Clients"]:::consumer
    end
    ISOXML -->|API calls| ExampleApp
    ISOXML -->|API calls| UnitTests
    ISOXML -->|API calls| NuGetClients

    %% CI/CD and Build Props
    subgraph "Configuration"
        CI["GitHub Actions CI/CD"]:::consumer
        Props["Shared Build Props"]:::consumer
    end
    CI -->|builds| CoreLibrary
    CI -->|builds| GenCLI
    Props -->|imported by| CoreLibrary
    Props -->|imported by| GenCLI

    %% Click Events
    click XSD "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML.Generation/resources/xsd"
    click GenCLI "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Dev4Agriculture.ISO11783.ISOXML.Generation/Program.cs"
    click GenCode "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/_generated"
    click Serializer "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Serializer"
    click Converters "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Converters"
    click DTOs "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/DTO"
    click Analysis "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Analysis"
    click Geometry "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Geometry"
    click Messaging "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Messaging"
    click Exceptions "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Exceptions"
    click IdHandling "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/IdHandling"
    click ISOExtensions "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/ISOExtensions"
    click Emulator "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Dev4Agriculture.ISO11783.ISOXML/Emulator/TaskControllerEmulator.cs"
    click Utils "https://github.com/dev4agriculture/isoxml-dotnet/tree/main/Dev4Agriculture.ISO11783.ISOXML/Utils"
    click ISOXML "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Dev4Agriculture.ISO11783.ISOXML/ISOXML.cs"
    click ExampleApp "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Dev4Agriculture.ISO11783.ISOXML.Example/Program.cs"
    click UnitTests "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Dev4Agriculture.ISO11783.ISOXML.Test"
    click CoreLibrary "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Dev4Agriculture.ISO11783.ISOXML/Dev4Agriculture.ISO11783.ISOXML.csproj"
    click CI "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/.github/workflows/dotnet.yml"
    click Props "https://github.com/dev4agriculture/isoxml-dotnet/blob/main/Directory.Build.props"

    %% Styles
    classDef generation fill:#cce5ff,stroke:#4da3ff,color:#000
    classDef core fill:#ccffcc,stroke:#33cc33,color:#000
    classDef consumer fill:#e0e0e0,stroke:#999999,color:#000
```
