libsensors_chip.h

Go to the documentation of this file.

/*
 * Software License Agreement (BSD License)
 *
 * Copyright (c) 2014, Open Source Robotics Foundation, Inc
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 *  * Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *  * Redistributions in binary form must reproduce the above
 *    copyright notice, this list of conditions and the following
 *    disclaimer in the documentation and/or other materials provided
 *    with the distribution.
 *  * Neither the name of the Open Source Robotics Foundation nor the
 *    names of its contributors may be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

/*
 * Author: Mitchell Wills
 */

#ifndef SENSOR_CHIP_H_
#define SENSOR_CHIP_H_

#include <stdlib.h>
#include <sensors/sensors.h>
#include <vector>
#include <boost/shared_ptr.hpp>

#include <diagnostic_updater/diagnostic_updater.h>

class SensorChipSubFeature;
class SensorChipFeature;
class SensorChip;

typedef boost::shared_ptr<SensorChip> SensorChipPtr;
typedef boost::shared_ptr<SensorChipFeature> SensorChipFeaturePtr;
typedef boost::shared_ptr<SensorChipSubFeature> SensorChipSubFeaturePtr;


class SensorChip{
private:
  std::string name_;
  sensors_chip_name const * internal_name_;
public:
  SensorChip(sensors_chip_name const *chip_name,
      const std::vector<std::string> &ignore);
  const std::string &getName() const {return name_;}
  std::vector<SensorChipFeaturePtr> features_;

  friend class SensorChipFeature;
  friend class SensorChipSubFeature;
};


class SensorChipFeature {
private:
  std::string name_;
  std::string label_;
  std::string full_name_;
  std::string full_label_;
  const SensorChip& chip_;
  sensors_feature const *feature_;
  void enumerate_subfeatures();

public:
  std::vector<SensorChipSubFeaturePtr> sub_features_;
  SensorChipFeature(const SensorChip& chip, sensors_feature const *feature);
  SensorChipSubFeaturePtr getSubFeatureByType(sensors_subfeature_type type);

  const std::string &getFeatureName() const {return name_;};
  const std::string &getFeatureLabel() const {return label_;};
  const std::string &getFullName() const {return full_name_;};
  const std::string &getFullLabel() const {return full_label_;};
  sensors_feature_type getType(){return feature_->type;};
  std::string getChipName(){return chip_.getName();};

  virtual void buildStatus(diagnostic_updater::DiagnosticStatusWrapper &stat) = 0;

  friend class SensorChipSubFeature;
};


class SensorChipSubFeature {
private:
  std::string name_;
  const SensorChipFeature& feature_;
  sensors_subfeature const *subfeature_;
public:
  SensorChipSubFeature(const SensorChipFeature& feature,
      sensors_subfeature const *subfeature);
  const std::string &getName() { return name_; }
  sensors_subfeature_type getType() { return subfeature_->type; }
  double getValue();
};


class FanSensor : public SensorChipFeature{
 public:
  FanSensor(const SensorChip& chip, sensors_feature const *feature) :
    SensorChipFeature(chip, feature) {}
  virtual void buildStatus(diagnostic_updater::DiagnosticStatusWrapper &stat);
};


class TempSensor : public SensorChipFeature{
 public:
  TempSensor(const SensorChip& chip, sensors_feature const *feature) :
    SensorChipFeature(chip, feature) {}
  virtual void buildStatus(diagnostic_updater::DiagnosticStatusWrapper &stat);
};


class VoltageSensor : public SensorChipFeature{
 public:
  VoltageSensor(const SensorChip& chip, sensors_feature const *feature) :
    SensorChipFeature(chip, feature) {}
  virtual void buildStatus(diagnostic_updater::DiagnosticStatusWrapper &stat);
};


class OtherSensor : public SensorChipFeature{
 public:
  OtherSensor(const SensorChip& chip, sensors_feature const *feature) :
    SensorChipFeature(chip, feature) {}
  virtual void buildStatus(diagnostic_updater::DiagnosticStatusWrapper &stat);
};


#endif