How dev4agriculture/isoxml-dotnet works
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