A framework for defining, managing, and serializing dynamic parameters with support for various data types, constraints, and payload generation, designed for applications requiring flexible parameter handling.
Get Started
$ dotnet add package Oakrey.ParametersReadme
Oakrey.Parameters
1. Overview
The "Parameters" project provides a framework for defining, managing, and serializing various types of parameters. It is designed to handle parameters with different data types, constraints, and serialization requirements, making it suitable for applications requiring dynamic parameter management.
2. Features
Parameter Types:
- ParameterBool, ParameterByte, ParameterDouble, ParameterEnum, ParameterInteger, ParameterString: Support for various data types.
- ParameterNested: Handles nested parameter structures.
Serialization and Deserialization:
Parameters can be serialized to and deserialized from XML using ExportXml and ParseKeyValues.
Payload Management:
Parameters can generate and interpret payloads for data transmission or storage.
Validation and Constraints:
Supports constraints like minimum/maximum values, length, and offsets for parameters.
Dynamic Parameter Handling:
- IParameter interface and ParameterBase class provide a flexible foundation for creating and managing parameters dynamically.
Error Handling:
- PayloadGenerateException: Custom exception for handling payload generation errors.
Integration with XML:
Leverages XML for parameter configuration and storage.
3. Installation
You can install the package via NuGet Package Manager, Package Manager Console or the .NET CLI.
NuGet Package Manager
- Open your project in Visual Studio.
- Navigate to Tools > NuGet Package Manager > Manage NuGet Packages for Solution....
- Search for
Oakrey.Parametersand click Install.
.NET CLI
Run the following command in your terminal:
dotnet add package Oakrey.Parameters
Package Manager Console
Run the following command in your Package Manager Console:
Install-Package Oakrey.Parameters
4. Requirements
- .NET 8 or higher
5. Project Information
- Author: Oakrey
- Company: Oakrey (Website Link)
- License: MIT
- Repository: Git Repository
- Project URL: Project Website
6. Contributing
Contributions are welcome! Feel free to open issues or submit pull requests to improve the package.
7. License
This project is licensed under the MIT License. See the LICENSE file for details.