Hardware/ISensor.cs
author moel.mich
Sun, 08 Aug 2010 13:57:26 +0000
changeset 165 813d8bc3192f
parent 159 eda3e3458cf4
child 195 0ee888c485d5
permissions -rw-r--r--
Refactored the hardware monitoring code into a library (Issue 101).
moel@1
     1
/*
moel@1
     2
  
moel@1
     3
  Version: MPL 1.1/GPL 2.0/LGPL 2.1
moel@1
     4
moel@1
     5
  The contents of this file are subject to the Mozilla Public License Version
moel@1
     6
  1.1 (the "License"); you may not use this file except in compliance with
moel@1
     7
  the License. You may obtain a copy of the License at
moel@1
     8
 
moel@1
     9
  http://www.mozilla.org/MPL/
moel@1
    10
moel@1
    11
  Software distributed under the License is distributed on an "AS IS" basis,
moel@1
    12
  WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
moel@1
    13
  for the specific language governing rights and limitations under the License.
moel@1
    14
moel@1
    15
  The Original Code is the Open Hardware Monitor code.
moel@1
    16
moel@1
    17
  The Initial Developer of the Original Code is 
moel@1
    18
  Michael Möller <m.moeller@gmx.ch>.
moel@1
    19
  Portions created by the Initial Developer are Copyright (C) 2009-2010
moel@1
    20
  the Initial Developer. All Rights Reserved.
moel@1
    21
moel@1
    22
  Contributor(s):
moel@1
    23
moel@1
    24
  Alternatively, the contents of this file may be used under the terms of
moel@1
    25
  either the GNU General Public License Version 2 or later (the "GPL"), or
moel@1
    26
  the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
moel@1
    27
  in which case the provisions of the GPL or the LGPL are applicable instead
moel@1
    28
  of those above. If you wish to allow use of your version of this file only
moel@1
    29
  under the terms of either the GPL or the LGPL, and not to allow others to
moel@1
    30
  use your version of this file under the terms of the MPL, indicate your
moel@1
    31
  decision by deleting the provisions above and replace them with the notice
moel@1
    32
  and other provisions required by the GPL or the LGPL. If you do not delete
moel@1
    33
  the provisions above, a recipient may use your version of this file under
moel@1
    34
  the terms of any one of the MPL, the GPL or the LGPL.
moel@1
    35
 
moel@1
    36
*/
moel@1
    37
moel@1
    38
using System;
moel@1
    39
using System.Collections.Generic;
moel@165
    40
using OpenHardwareMonitor.Collections;
moel@1
    41
moel@1
    42
namespace OpenHardwareMonitor.Hardware {
moel@1
    43
moel@1
    44
  public enum SensorType {
moel@1
    45
    Voltage,
moel@24
    46
    Clock,    
moel@1
    47
    Temperature,
moel@24
    48
    Load,
moel@57
    49
    Fan,
moel@118
    50
    Flow,
moel@118
    51
    Control
moel@1
    52
  }
moel@1
    53
moel@159
    54
  public struct SensorValue {
moel@159
    55
    private float value;
moel@159
    56
    private DateTime time;
moel@159
    57
moel@159
    58
    public SensorValue(float value, DateTime time) {
moel@159
    59
      this.value = value;
moel@159
    60
      this.time = time;
moel@159
    61
    }
moel@159
    62
moel@159
    63
    public float Value { get { return value; } }
moel@159
    64
    public DateTime Time { get { return time; } }
moel@1
    65
  }
moel@1
    66
moel@110
    67
  public interface ISensor : IElement {
moel@63
    68
moel@28
    69
    IHardware Hardware { get; }
moel@63
    70
moel@1
    71
    SensorType SensorType { get; }
moel@109
    72
    Identifier Identifier { get; }
moel@109
    73
moel@1
    74
    string Name { get; set; }
moel@1
    75
    int Index { get; }
moel@63
    76
moel@109
    77
    bool IsDefaultHidden { get; }
moel@109
    78
moel@63
    79
    IReadOnlyArray<IParameter> Parameters { get; }
moel@63
    80
moel@1
    81
    float? Value { get; }
moel@1
    82
    float? Min { get; }
moel@151
    83
    float? Max { get; }
moel@151
    84
moel@151
    85
    void ResetMin();
moel@151
    86
    void ResetMax();
moel@63
    87
moel@159
    88
    IEnumerable<SensorValue> Values { get; }
moel@1
    89
  }
moel@1
    90
moel@1
    91
}