Files
CarlMonitor/LibreHardwareMonitor-0.9.4/LibreHardwareMonitorLib/Hardware/Storage/SmartAttribute.cs
2025-04-07 07:44:27 -07:00

102 lines
3.9 KiB
C#

// This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
// If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.
// Copyright (C) LibreHardwareMonitor and Contributors.
// Partial Copyright (C) Michael Möller <mmoeller@openhardwaremonitor.org> and Contributors.
// All Rights Reserved.
using System.Collections.Generic;
using LibreHardwareMonitor.Interop;
namespace LibreHardwareMonitor.Hardware.Storage;
public class SmartAttribute
{
private readonly RawValueConversion _rawValueConversion;
public delegate float RawValueConversion(byte[] rawValue, byte value, IReadOnlyList<IParameter> parameters);
/// <summary>
/// Initializes a new instance of the <see cref="SmartAttribute" /> class.
/// </summary>
/// <param name="id">The SMART id of the attribute.</param>
/// <param name="name">The name of the attribute.</param>
public SmartAttribute(byte id, string name) : this(id, name, null, null, 0, null)
{ }
/// <summary>
/// Initializes a new instance of the <see cref="SmartAttribute" /> class.
/// </summary>
/// <param name="id">The SMART id of the attribute.</param>
/// <param name="name">The name of the attribute.</param>
/// <param name="rawValueConversion">
/// A delegate for converting the raw byte
/// array into a value (or null to use the attribute value).
/// </param>
public SmartAttribute(byte id, string name, RawValueConversion rawValueConversion) : this(id, name, rawValueConversion, null, 0, null)
{ }
/// <summary>
/// Initializes a new instance of the <see cref="SmartAttribute" /> class.
/// </summary>
/// <param name="id">The SMART id of the attribute.</param>
/// <param name="name">The name of the attribute.</param>
/// <param name="rawValueConversion">
/// A delegate for converting the raw byte
/// array into a value (or null to use the attribute value).
/// </param>
/// <param name="sensorType">
/// Type of the sensor or null if no sensor is to
/// be created.
/// </param>
/// <param name="sensorChannel">
/// If there exists more than one attribute with
/// the same sensor channel and type, then a sensor is created only for the
/// first attribute.
/// </param>
/// <param name="sensorName">
/// The name to be used for the sensor, or null if
/// no sensor is created.
/// </param>
/// <param name="defaultHiddenSensor">True to hide the sensor initially.</param>
/// <param name="parameterDescriptions">
/// Description for the parameters of the sensor
/// (or null).
/// </param>
public SmartAttribute(byte id, string name, RawValueConversion rawValueConversion, SensorType? sensorType, int sensorChannel, string sensorName, bool defaultHiddenSensor = false, ParameterDescription[] parameterDescriptions = null)
{
Id = id;
Name = name;
_rawValueConversion = rawValueConversion;
SensorType = sensorType;
SensorChannel = sensorChannel;
SensorName = sensorName;
DefaultHiddenSensor = defaultHiddenSensor;
ParameterDescriptions = parameterDescriptions;
}
public bool DefaultHiddenSensor { get; }
public bool HasRawValueConversion => _rawValueConversion != null;
/// <summary>
/// Gets the SMART identifier.
/// </summary>
public byte Id { get; }
public string Name { get; }
public ParameterDescription[] ParameterDescriptions { get; }
public int SensorChannel { get; }
public string SensorName { get; }
public SensorType? SensorType { get; }
internal float ConvertValue(Kernel32.SMART_ATTRIBUTE value, IReadOnlyList<IParameter> parameters)
{
if (_rawValueConversion == null)
return value.CurrentValue;
return _rawValueConversion(value.RawValue, value.CurrentValue, parameters);
}
}