DiagKit.VectorCdd 1.0.0

DiagKit.VectorCdd

A C# library for reading Vector CANoe .cdd files (CANdela Diagnostic Description) and decoding raw UDS diagnostic bytes into human-readable values.

.cdd files are XML documents based on the CANDELA schema. VectorCdd deserializes that XML into a typed object model, wires cross-references, and applies the data type definitions found in the file to convert diagnostic payloads.

Requirements

• .NET 10.0 SDK
• MSTest for the test project

Install

dotnet add package DiagKit.VectorCdd

Build And Test

dotnet restore DiagKit.VectorCdd.slnx
dotnet build DiagKit.VectorCdd.slnx
dotnet test DiagKit.VectorCdd.slnx
dotnet test DiagKit.VectorCdd.slnx --filter "TestCategory!=Integration"
dotnet pack src/VectorCdd/VectorCdd.csproj -c Release

Integration tests expect private .cdd fixtures configured through ref/cdd-files.json outside the public repository. Public CI runs non-integration tests by default.

Quick Start

using DiagKit.VectorCdd.Common;
using DiagKit.VectorCdd.XmlParser;

var xml = File.ReadAllText("sample.cdd");
var candela = xml.DeserializeXmlToObject<CanDela>();

// Wire cross-references such as dtref links.
candela.SetCanDelaReference();

// Optional: choose the language used by Name/Description/TextTable lookups.
candela.Language = "en-US";

var did = candela.EcuDocument.DataIdentities.DataIdentities
    .First(d => d.DataIdentityValue == 0xF190);

var result = did.Convert(Convert.FromHexString("01020304"));
Console.WriteLine(result.DisplayText());

Object Model

Most CDD model objects derive from CanDelaBase and General.

• CanDelaBase stores a reference to the root CanDela document.
• General exposes common CANDELA attributes such as id, oid, temploid, NAME, DESC, QUAL, and dtref.
• CanDela.SetCanDelaReference() should be called after deserialization so reference properties can resolve linked objects.

Decoding Model

The DataTypes namespace contains the conversion engine:

• ValueType interprets bytes as unsigned/signed integers, BCD, floats, ASCII, or Unicode using the CDD byte order and display format.
• Identity passes decoded values through without physical conversion.
• Linear applies physical = (code * factor / divisor) + offset and validates configured ranges.
• TextTable maps numeric values to localized text.
• Packet decodes structured data objects in sequence.
• BitsField decodes bit-level structures.
• Multiplexer selects a structure based on a selector value.

All decodable objects implement IConvert.Convert(byte[] rawData) and return BaseDataType.ConvertResult.

Language Selection

Language selection is instance-based. Set CanDela.Language to choose the default language for a parsed document. Individual General-derived objects can set their own Language override.

This replaces the old global General.Language behavior so multiple CDD documents can be decoded concurrently without changing each other's localized text.

Error Handling

Expected input or CDD-domain issues are returned as unsuccessful ConvertResult values with an error type and message. Programming errors, unsupported model shapes, and corrupted object state throw exceptions so callers keep the original stack trace.

License

This project is licensed under the Apache License 2.0. See LICENSE.