RedundantSensor Class Reference

#include <redundant_sensor.h>

Inheritance diagram for RedundantSensor:

Collaboration diagram for RedundantSensor:

Public Member Functions
	RedundantSensor (SensorType outputType, SensorType firstSensor, SensorType secondSensor)
void	configure (float maxDifference, bool ignoreSecondSensor)
SensorResult	get () const override
bool	isRedundant () const override
void	showInfo (const char *sensorName) const override
Public Member Functions inherited from Sensor
bool	Register ()
const char *	getSensorName () const
virtual bool	hasSensor () const
virtual float	getRaw () const
void	unregister ()
SensorType	type () const

Private Attributes
const SensorType	m_first
const SensorType	m_second
float	m_maxDifference = 0
bool	m_ignoreSecond = false

Additional Inherited Members
Static Public Member Functions inherited from Sensor
static void	showAllSensorInfo ()
static void	showInfo (SensorType type)
static void	resetRegistry ()
static const Sensor *	getSensorOfType (SensorType type)
static SensorResult	get (SensorType type)
static float	getOrZero (SensorType type)
static float	getRaw (SensorType type)
static bool	isRedundant (SensorType type)
static bool	hasSensor (SensorType type)
static void	setMockValue (SensorType type, float value, bool mockRedundant=false)
static void	setInvalidMockValue (SensorType type)
static void	resetMockValue (SensorType type)
static void	resetAllMocks ()
static void	inhibitTimeouts (bool inhibit)
static const char *	getSensorName (SensorType type)
Protected Member Functions inherited from Sensor
	Sensor (SensorType type)
Static Protected Attributes inherited from Sensor
static bool	s_inhibitSensorTimeouts = false

Detailed Description

Definition at line 5 of file redundant_sensor.h.

Constructor & Destructor Documentation

RedundantSensor()

RedundantSensor::RedundantSensor	(	SensorType	outputType,
		SensorType	firstSensor,
		SensorType	secondSensor
	)

Definition at line 5 of file redundant_sensor.cpp.

    : Sensor(outputType)
    , m_first(first)
    , m_second(second)
{
}

Member Function Documentation

configure()

void RedundantSensor::configure	(	float	maxDifference,
		bool	ignoreSecondSensor
	)

Definition at line 12 of file redundant_sensor.cpp.

                                                                             {
    m_maxDifference = maxDifference;
    m_ignoreSecond = ignoreSecondSensor;
}

get()

SensorResult RedundantSensor::get ( ) const

overridevirtual

Implements Sensor.

Definition at line 17 of file redundant_sensor.cpp.

                                        {
    auto sensor1 = Sensor::get(m_first);
 
    // If we're set to disable redundancy, just pass thru the first sensor
    if (m_ignoreSecond) {
        return sensor1;
    }
 
    auto sensor2 = Sensor::get(m_second);
 
    // If either result is invalid, return invalid.
    if (!sensor1.Valid || !sensor2.Valid) {
        return UnexpectedCode::Inconsistent;
    }
 
    // If both are valid, check that they're near one another
    float delta = absF(sensor1.Value - sensor2.Value);
    if (delta > m_maxDifference) {
        return UnexpectedCode::Inconsistent;
    }
 
    // Both sensors are valid, and their readings are close. All is well.
    // Return the average
    return (sensor1.Value + sensor2.Value) / 2;
}

Here is the call graph for this function:

isRedundant()

bool RedundantSensor::isRedundant ( ) const

inlineoverridevirtual

Reimplemented from Sensor.

Definition at line 18 of file redundant_sensor.h.

                                      {
        // This sensor is redundant when not ignoring the second channel
        return !m_ignoreSecond;
    }

showInfo()

void RedundantSensor::showInfo ( const char *  sensorName ) const

overridevirtual

Implements Sensor.

Definition at line 50 of file sensor_info_printing.cpp.

                                                           {
    efiPrintf("Sensor \"%s\" is redundant combining \"%s\" and \"%s\"", sensorName, getSensorName(m_first), getSensorName(m_second));
}

Here is the call graph for this function:

Field Documentation

m_first

const SensorType RedundantSensor::m_first

private

Definition at line 27 of file redundant_sensor.h.

Referenced by get(), and showInfo().

m_ignoreSecond

bool RedundantSensor::m_ignoreSecond = false

private

Definition at line 34 of file redundant_sensor.h.

Referenced by configure(), get(), and isRedundant().

m_maxDifference

float RedundantSensor::m_maxDifference = 0

private

Definition at line 31 of file redundant_sensor.h.

Referenced by configure(), and get().

m_second

const SensorType RedundantSensor::m_second

private

Definition at line 28 of file redundant_sensor.h.

Referenced by get(), and showInfo().

---

The documentation for this class was generated from the following files:

• controllers/sensors/redundant_sensor.h
• controllers/sensors/redundant_sensor.cpp
• controllers/sensors/sensor_info_printing.cpp