Hardware/Sensor.cs
author moel.mich
Sat, 17 Jul 2010 13:25:42 +0000
changeset 155 8ffea928daad
parent 134 8b3b9b2e28e5
child 159 eda3e3458cf4
permissions -rw-r--r--
Fixed Issue 91.
     1 /*
     2   
     3   Version: MPL 1.1/GPL 2.0/LGPL 2.1
     4 
     5   The contents of this file are subject to the Mozilla Public License Version
     6   1.1 (the "License"); you may not use this file except in compliance with
     7   the License. You may obtain a copy of the License at
     8  
     9   http://www.mozilla.org/MPL/
    10 
    11   Software distributed under the License is distributed on an "AS IS" basis,
    12   WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
    13   for the specific language governing rights and limitations under the License.
    14 
    15   The Original Code is the Open Hardware Monitor code.
    16 
    17   The Initial Developer of the Original Code is 
    18   Michael Möller <m.moeller@gmx.ch>.
    19   Portions created by the Initial Developer are Copyright (C) 2009-2010
    20   the Initial Developer. All Rights Reserved.
    21 
    22   Contributor(s):
    23 
    24   Alternatively, the contents of this file may be used under the terms of
    25   either the GNU General Public License Version 2 or later (the "GPL"), or
    26   the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
    27   in which case the provisions of the GPL or the LGPL are applicable instead
    28   of those above. If you wish to allow use of your version of this file only
    29   under the terms of either the GPL or the LGPL, and not to allow others to
    30   use your version of this file under the terms of the MPL, indicate your
    31   decision by deleting the provisions above and replace them with the notice
    32   and other provisions required by the GPL or the LGPL. If you do not delete
    33   the provisions above, a recipient may use your version of this file under
    34   the terms of any one of the MPL, the GPL or the LGPL.
    35  
    36 */
    37 
    38 using System;
    39 using System.Collections.Generic;
    40 using OpenHardwareMonitor.Utilities;
    41 
    42 namespace OpenHardwareMonitor.Hardware {
    43 
    44   public class Sensor : ISensor {
    45 
    46     private string defaultName;
    47     private string name;
    48     private int index;
    49     private bool defaultHidden;
    50     private SensorType sensorType;
    51     private IHardware hardware;
    52     private ReadOnlyArray<IParameter> parameters;
    53     private float? value;
    54     private float? min;
    55     private float? max;
    56     private Queue<ISensorEntry> entries = 
    57       new Queue<ISensorEntry>(MAX_MINUTES * 15);
    58     
    59     private float sum = 0;
    60     private int count = 0;
    61 
    62     private const int MAX_MINUTES = 120;
    63    
    64     public Sensor(string name, int index, SensorType sensorType,
    65       IHardware hardware) : this(name, index, sensorType, hardware, 
    66       null) { }
    67 
    68     public Sensor(string name, int index, SensorType sensorType,
    69       IHardware hardware, ParameterDescription[] parameterDescriptions) :
    70       this(name, index, false, sensorType, hardware,
    71         parameterDescriptions) { }
    72 
    73     public Sensor(string name, int index, bool defaultHidden, 
    74       SensorType sensorType, IHardware hardware, 
    75       ParameterDescription[] parameterDescriptions) 
    76     {
    77       this.defaultName = name;      
    78       this.index = index;
    79       this.defaultHidden = defaultHidden;
    80       this.sensorType = sensorType;
    81       this.hardware = hardware;
    82       Parameter[] parameters = new Parameter[parameterDescriptions == null ?
    83         0 : parameterDescriptions.Length];
    84       for (int i = 0; i < parameters.Length; i++ ) 
    85         parameters[i] = new Parameter(parameterDescriptions[i], this);
    86       this.parameters = parameters;
    87 
    88       string configName = Config.Settings[
    89         new Identifier(Identifier, "name").ToString()];
    90       if (configName != null)
    91         this.name = configName;
    92       else
    93         this.name = name;
    94     }
    95 
    96     public IHardware Hardware {
    97       get { return hardware; }
    98     }
    99 
   100     public SensorType SensorType {
   101       get { return sensorType; }
   102     }
   103 
   104     public Identifier Identifier {
   105       get {
   106         return new Identifier(hardware.Identifier, 
   107           sensorType.ToString().ToLower(), index.ToString());
   108       }
   109     }
   110 
   111     public string Name {
   112       get { 
   113         return name; 
   114       }
   115       set {
   116         if (value != "") 
   117           name = value;          
   118         else 
   119           name = defaultName;
   120         Config.Settings[new Identifier(Identifier, "name").ToString()] = name;
   121       }
   122     }
   123 
   124     public int Index {
   125       get { return index; }
   126     }
   127 
   128     public bool IsDefaultHidden {
   129       get { return defaultHidden; }
   130     }
   131 
   132     public IReadOnlyArray<IParameter> Parameters {
   133       get { return parameters; }
   134     }
   135 
   136     public float? Value {
   137       get { 
   138         return value; 
   139       }
   140       set {
   141         while (entries.Count > 0 && 
   142           (DateTime.Now - entries.Peek().Time).TotalMinutes > MAX_MINUTES)
   143           entries.Dequeue();
   144 
   145         if (value.HasValue) {
   146           sum += value.Value;
   147           count++;
   148           if (count == 4) {
   149             entries.Enqueue(new Entry(sum / count, DateTime.Now));
   150             sum = 0;
   151             count = 0;
   152           }
   153         }
   154 
   155         this.value = value;
   156         if (min > value || !min.HasValue)
   157           min = value;
   158         if (max < value || !max.HasValue)
   159           max = value;
   160       }
   161     }
   162 
   163     public float? Min { get { return min; } }
   164     public float? Max { get { return max; } }
   165 
   166     public void ResetMin() {
   167       min = null;
   168     }
   169 
   170     public void ResetMax() {
   171       max = null;
   172     }
   173 
   174     public IEnumerable<ISensorEntry> Plot {
   175       get { return entries; }
   176     }
   177 
   178     public struct Entry : ISensorEntry {
   179       private float value;
   180       private DateTime time;
   181 
   182       public Entry(float value, DateTime time) {
   183         this.value = value;
   184         this.time = time;
   185       }
   186 
   187       public float Value { get { return value; } }
   188       public DateTime Time { get { return time; } }
   189     }
   190 
   191     public void Accept(IVisitor visitor) {
   192       visitor.VisitSensor(this);
   193     }
   194 
   195     public void Traverse(IVisitor visitor) {
   196       foreach (IParameter parameter in parameters)
   197         parameter.Accept(visitor);
   198     }
   199   }
   200 }