📑 Computer Domain Class Documentation
Welcome to the comprehensive documentation for the Computer domain class in the IrbyImaging.DomainClasses assembly. This guide provides a deep dive into the class design, its properties, relationships, and usage examples. Whether you’re integrating it into an asset management system or extending it, you’ll find everything you need right here.
🗂 Table of Contents
- Overview & Purpose
- Dependencies & Technologies
- UML Class Diagram
- Data Model: Computer Class
4.1. Inheritance
4.2. Properties
4.3. Constructor - Usage Example
- Integration Points
- Helper Methods & Utilities
- Error Handling & Return Types
- API Endpoints Overview
- Third-party Integrations
- Conclusion
1. Overview & Purpose
Computer is a domain entity that represents a computer asset within the IrbyImaging asset management solution.
It extends the base Asset class and captures all properties specific to computers, such as operating system, asset tags, and inventory numbers.
- 🖥️ What it models: A physical or virtual computer device owned or managed by an organization.
- 🎯 Intended use: Track, categorize, and query computer assets in applications like inventory systems or help-desk platforms.
2. Dependencies & Technologies
| Layer/Technology | Purpose |
|---|---|
| C# / .NET | Language & runtime |
| IrbyImaging.DomainClasses | Contains this and other domain entities |
| IrbyImaging.Utility | Provides AssetCategory enum |
| Entity Framework (optional) | ORM for persisting to a database |
3. UML Class Diagram
+-----------------------------+
| Asset |
+-----------------------------+
| − Id: int |
| − Name: string |
| − Category: AssetCategory |
| ... |
+-----------------------------+
▲
|
+---------------------------+
| Computer |
+---------------------------+
| + OperatingSystemId: int |
| + OperatingSystem: OS |
| + AssetNumber: string |
| + UnitNumber: string |
| + CpsNumber: string |
+---------------------------+
Note: The base class
Assetmay define common fields (e.g.,Id,Name,Category, etc.).
4. Data Model: Computer Class
namespace IrbyImaging.DomainClasses
{
/// <summary>
/// Represents a computer asset in the system.
/// </summary>
public class Computer : Asset
{
/// <summary>
/// Default constructor sets the Category to Computer.
/// </summary>
public Computer()
{
Category = IrbyImaging.Utility.AssetCategory.Computer;
}
public int OperatingSystemId { get; set; }
public OperatingSystem OperatingSystem { get; set; }
public string AssetNumber { get; set; }
public string UnitNumber { get; set; }
public string CpsNumber { get; set; }
}
}
4.1 Inheritance
- Base Class:
Asset - Derived Class:
Computer - Purpose: Inherit common asset properties (e.g.,
Id,Name,Category) and extend with computer-specific fields.
4.2 Properties
| Property | Type | Description |
|---|---|---|
OperatingSystemId |
int |
Foreign key linking to an OperatingSystem entity. |
OperatingSystem |
OperatingSystem |
Navigation property to the OS details (e.g., Windows, Linux). |
AssetNumber |
string |
Unique tracking number assigned to the computer. |
UnitNumber |
string |
Internal location or unit identifier (e.g., rack, office code). |
CpsNumber |
string |
CPS (Computer Processing System) number or custom tracking code. |
4.3 Constructor
- Computer()
- Sets
CategorytoAssetCategory.Computerby default. - Ensures that every instance is correctly classified.
- Sets
5. Usage Example
using IrbyImaging.DomainClasses;
using IrbyImaging.Utility;
public class AssetManager
{
public void CreateComputerAsset()
{
// Instantiate a new Computer
var pc = new Computer
{
AssetNumber = "ASSET-2022-0001",
UnitNumber = "UNIT-42",
CpsNumber = "CPS-100A",
OperatingSystemId = 3 // Assume 3 corresponds to "Windows 10"
};
// Optionally, load the OperatingSystem entity via ORM
// pc.OperatingSystem = dbContext.OperatingSystems.Find(3);
// Save pc to database...
}
}
6. Integration Points
OperatingSystem Relationship
OperatingSystemId- Serves as a foreign key.
OperatingSystem- Navigation property; eager or lazy-loaded depending on your ORM configuration.
AssetCategory Enumeration
Located in IrbyImaging.Utility:
public enum AssetCategory
{
Computer,
Printer,
Networking,
// ... other categories
}
The constructor sets:
Category = AssetCategory.Computer;
7. Helper Methods & Utilities
Currently, the
Computerclass exposes only a default constructor.
No additional helper methods are defined at this layer.
8. Error Handling & Return Types
- No custom methods that throw exceptions or return values.
- All properties are auto-implemented; validation must occur at a higher service or UI layer.
9. API Endpoints Overview
None
This is a domain class; API controllers or services are responsible for exposing HTTP endpoints.
10. Third-party Integrations
- Entity Framework (EF Core) or any ORM can map
Computerto a database table. - No direct integration with external services within this class.
11. Conclusion
The Computer class is a straightforward, extendable domain entity designed to model computer assets within the IrbyImaging platform. By inheriting from Asset, it reuses common asset properties and adds computer-centric details like operating system references and inventory tags.
Use this class as the foundational block in your asset management workflows—whether persisting to a database, exposing it via APIs, or enriching it with business logic in service layers. Happy coding! 🚀
Document generated by the IrbyImaging Developer Documentation Tool