Tmc9660TemperatureWrapper Class Reference

Adapter wrapping Tmc9660Handler's internal temperature into BaseTemperature. More...

#include <TemperatureManager.h>

Inheritance diagram for Tmc9660TemperatureWrapper:

Collaboration diagram for Tmc9660TemperatureWrapper:

Public Member Functions
	Tmc9660TemperatureWrapper (Tmc9660Handler &handler) noexcept
	Construct the wrapper around an existing Tmc9660Handler.
	~Tmc9660TemperatureWrapper () override=default
bool	Initialize () noexcept override
	Initialise the underlying TMC9660 temperature path.
bool	Deinitialize () noexcept override
	Deinitialise the underlying TMC9660 temperature path.
hf_temp_err_t	ReadTemperatureCelsiusImpl (float *temperature_celsius) noexcept override
	Read the TMC9660 chip temperature in Celsius.
hf_temp_err_t	GetSensorInfo (hf_temp_sensor_info_t *info) const noexcept override
	Retrieve sensor information for the TMC9660.
hf_u32_t	GetCapabilities () const noexcept override
	Get capability flags for this sensor.

Private Attributes
Tmc9660Handler &	handler_

Detailed Description

Adapter wrapping Tmc9660Handler's internal temperature into BaseTemperature.

Constructor & Destructor Documentation

Tmc9660TemperatureWrapper()

Tmc9660TemperatureWrapper::Tmc9660TemperatureWrapper ( Tmc9660Handler &  handler )

explicitnoexcept

Construct the wrapper around an existing Tmc9660Handler.

Parameters

handler

Reference to the TMC9660 handler (must outlive this wrapper).

~Tmc9660TemperatureWrapper()

Tmc9660TemperatureWrapper::~Tmc9660TemperatureWrapper ( )

overridedefault

Member Function Documentation

Deinitialize()

bool Tmc9660TemperatureWrapper::Deinitialize ( )

overridenoexcept

Deinitialise the underlying TMC9660 temperature path.

GetCapabilities()

hf_u32_t Tmc9660TemperatureWrapper::GetCapabilities ( ) const

overridenoexcept

Get capability flags for this sensor.

Returns

Bitmask of supported capabilities.

GetSensorInfo()

hf_temp_err_t Tmc9660TemperatureWrapper::GetSensorInfo ( hf_temp_sensor_info_t *  info ) const

overridenoexcept

Retrieve sensor information for the TMC9660.

Parameters

info	Pointer to the info struct to fill.

Returns

TEMP_SUCCESS on success.

Initialize()

bool Tmc9660TemperatureWrapper::Initialize ( )

overridenoexcept

Initialise the underlying TMC9660 temperature path.

ReadTemperatureCelsiusImpl()

hf_temp_err_t Tmc9660TemperatureWrapper::ReadTemperatureCelsiusImpl ( float *  temperature_celsius )

overridenoexcept

Read the TMC9660 chip temperature in Celsius.

Parameters

temperature_celsius

Pointer to store the reading.

Returns

TEMP_SUCCESS on success.

Member Data Documentation

handler_

Tmc9660Handler& Tmc9660TemperatureWrapper::handler_

private

---

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

• TemperatureManager.h
• TemperatureManager.cpp