πŸ“¦ AssetModel.cs Documentation

Welcome to the comprehensive documentation for AssetModel.cs, part of the IrbyImaging.DomainClasses assembly. This document will guide you through the purpose, structure, usage, and relationships of the AssetModel and AssetModelDetail classes, complete with examples, tables, and a UML diagram.


πŸ“‘ Table of Contents

  1. Overview & Purpose
  2. Dependencies & Technologies
  3. Key Functional Areas
  4. Data Models
  5. Properties & Annotations
  6. Relationships & Navigation
  7. UML Class Diagram
  8. Usage Examples
  9. Sample Code Snippets
  10. Conclusion

🎯 Overview & Purpose

The AssetModel.cs file defines two core domain entities used in the Irby Imaging system:

  • AssetModel
    Represents a template or blueprint for imaging assets (e.g., cameras, scanners) manufactured by a company.
  • AssetModelDetail
    Additional detail records associated with an asset model, used for extended configuration or versioning.

These classes are designed to work with Entity Framework Core, enabling database mapping, queries, and CRUD operations in a clean, maintainable way.


βš™οΈ Dependencies & Technologies

Technology / Package Purpose
.NET Core / .NET Framework Overall runtime
Entity Framework Core (EF Core) Object–relational mapping (ORM)
System.ComponentModel.DataAnnotations Validation & data-model annotations
System.ComponentModel.DataAnnotations.Schema Table mapping
IrbyImaging.Utility Shared utility types/enums (e.g. DeviceType)

πŸ”‘ Key Functional Areas

  • ORM Mapping: [Table], [Key], and navigation properties for EF Core.
  • Data Validation & Display: [Display] attributes for UI hints.
  • Domain Modeling: Clean representation of asset manufacturer, type, category, and details.
  • Extension Points: Collection of AssetModelDetail for further customization.

πŸ“ Data Models

AssetModel

[Table("AssetModel", Schema = "irby")]
public class AssetModel
{
    [Key]
    public int Id { get; set; }

    public int MakeId { get; set; }
    public Manufacturer Make { get; set; }

    public string Name { get; set; }
    public AssetCategory Category { get; set; }
    public DeviceType? Type { get; set; }

    [Display(Name = "Available?")]
    public bool IsAvailableOption { get; set; }

    public List<AssetModelDetail> AssetsModelDetail { get; set; }
}

Property Summary

Property Type Description
Id int Primary key identifier
MakeId int Foreign key to Manufacturer
Make Manufacturer Navigation property to the manufacturer entity
Name string Human-readable model name
Category AssetCategory Asset categorization (enum)
Type DeviceType? Optional device type (enum)
IsAvailableOption bool Flag indicating availability in UI forms
AssetsModelDetail List<AssetModelDetail> Child details – versions, configurations, etc.

AssetModelDetail

public class AssetModelDetail
{
    public int Id { get; set; }
    public int MakeId { get; set; }
    public Manufacturer Make { get; set; }
    public string Name { get; set; }
    public AssetCategory Category { get; set; }
    public DeviceType? Type { get; set; }
    public bool IsAvailableOption { get; set; }
}

Note: Although AssetModelDetail shares many fields with AssetModel, it is typically used for finer-grained records (e.g., version-specific details).


πŸ”— Relationships & Navigation

  • AssetModel ↔ Manufacturer
    One-to-many: each AssetModel references a single Manufacturer via MakeId.
  • AssetModel ↔ AssetModelDetail
    One-to-many: each AssetModel can have multiple AssetModelDetail entries.
  • Enumerations
    • AssetCategory: Grouping of assets (e.g., Hardware, Software).
    • DeviceType: Specific device classification (e.g., Scanner, Printer).

πŸ–ΌοΈ UML Class Diagram

classDiagram
    direction LR

    class AssetModel {
        +int Id
        +int MakeId
        +string Name
        +AssetCategory Category
        +DeviceType? Type
        +bool IsAvailableOption
        +List~AssetModelDetail~ AssetsModelDetail
    }

    class AssetModelDetail {
        +int Id
        +int MakeId
        +string Name
        +AssetCategory Category
        +DeviceType? Type
        +bool IsAvailableOption
    }

    class Manufacturer
    class AssetCategory
    class DeviceType

    AssetModel "1" --> "1" Manufacturer : Make
    AssetModel "1" --> "*" AssetModelDetail : AssetsModelDetail
    AssetModelDetail "1" --> "1" Manufacturer : Make

πŸ’‘ Usage Examples

1. Adding a New AssetModel

using (var context = new IrbyDbContext())
{
    var manufacturer = context.Manufacturers.First(m => m.Id == 1);
    var newModel = new AssetModel
    {
        Make = manufacturer,
        Name = "X2000 Scanner Pro",
        Category = AssetCategory.Hardware,
        Type = DeviceType.Scanner,
        IsAvailableOption = true,
        AssetsModelDetail = new List<AssetModelDetail>
        {
            new AssetModelDetail
            {
                Make = manufacturer,
                Name = "X2000 Scanner Pro - V2",
                Category = AssetCategory.Hardware,
                Type = DeviceType.Scanner,
                IsAvailableOption = false
            }
        }
    };

    context.AssetModels.Add(newModel);
    context.SaveChanges();
}

2. Querying AssetModels with Details

var modelsWithDetails = context.AssetModels
    .Include(am => am.Make)
    .Include(am => am.AssetsModelDetail)
    .Where(am => am.IsAvailableOption)
    .ToList();

foreach (var model in modelsWithDetails)
{
    Console.WriteLine($"{model.Name} by {model.Make.Name}");
    foreach (var detail in model.AssetsModelDetail)
    {
        Console.WriteLine($"  - Detail: {detail.Name}, Available: {detail.IsAvailableOption}");
    }
}

πŸ› οΈ Sample Code Snippets

LINQ Filtering by Category

var hardwareModels = context.AssetModels
    .Where(m => m.Category == AssetCategory.Hardware)
    .ToList();

Toggling Availability

var asset = context.AssetModels.Find(5);
asset.IsAvailableOption = !asset.IsAvailableOption;
context.SaveChanges();

βœ… Conclusion

The AssetModel and AssetModelDetail classes form the backbone of the Irby Imaging domain for modeling and persisting asset templates and their extended details. With clear ORM mappings, rich navigation properties, and straightforward usage patterns, these classes help you manage your asset catalog efficiently.

Happy coding! πŸš€