Driver::RHTemp::Simulated::Api Class Reference

This class implements the RH/Temperature driver interface using model points as the physical signals. More...

Detailed Description

This class implements the RH/Temperature driver interface using model points as the physical signals.

The Application is responsible for providing the Model Point instances.

The class is NOT thread safe. The application is RESPONSIBLE for ensuring thread-safe usage.

#include <Api.h>

Inheritance diagram for Driver::RHTemp::Simulated::Api:

Collaboration diagram for Driver::RHTemp::Simulated::Api:

Public Member Functions
	Api (Cpl::Dm::Mp::Float &simulatedRHInputMP, Cpl::Dm::Mp::Float &simulatedTempInputMP, Cpl::Dm::Mp::Bool &simulateHeaterStateMP)
	Constructor.
bool	start () noexcept
	See Driver::RHTemp::Api.
void	stop () noexcept
	See Driver::RHTemp::Api.
bool	sample (float &rhOut, float &tempCOut) noexcept
	See Driver::RHTemp::Api.
bool	setHeaterState (bool enabled) noexcept
	See Driver::RHTemp::Api.
Driver::RHTemp::Api::SamplingState_T	startSample () noexcept
	See Driver::RHTemp::Api.
Driver::RHTemp::Api::SamplingState_T	getSamplingState () noexcept
	See Driver::RHTemp::Api.
Driver::RHTemp::Api::SamplingState_T	getSample (float &rhOut, float &tempCOut) noexcept
	See Driver::RHTemp::Api.
Public Member Functions inherited from Driver::RHTemp::Api
virtual	~Api ()
	Virtual destructor.

Protected Attributes
Cpl::Dm::Mp::Float &	m_mpRh
	Simulated input value.
Cpl::Dm::Mp::Float &	m_mpTemp
	Simulated input value.
Cpl::Dm::Mp::Bool &	m_mpHeaterEnabled
	Simulated output value.
bool	m_started
	Started state.

Additional Inherited Members
Public Types inherited from Driver::RHTemp::Api
enum	SamplingState_T { eNOT_STARTED , eSAMPLING , eSAMPLE_READY , eERROR }
	State of the non-blocking sampling. More...

Constructor & Destructor Documentation

Api()

Driver::RHTemp::Simulated::Api::Api	(	Cpl::Dm::Mp::Float &	simulatedRHInputMP,
		Cpl::Dm::Mp::Float &	simulatedTempInputMP,
		Cpl::Dm::Mp::Bool &	simulateHeaterStateMP
	)

Constructor.

Member Function Documentation

getSample()

Driver::RHTemp::Api::SamplingState_T Driver::RHTemp::Simulated::Api::getSample ( float &  rhOut, float &  tempCOut  )

virtualnoexcept

See Driver::RHTemp::Api.

Implements Driver::RHTemp::Api.

getSamplingState()

Driver::RHTemp::Api::SamplingState_T Driver::RHTemp::Simulated::Api::getSamplingState ( )

virtualnoexcept

See Driver::RHTemp::Api.

Implements Driver::RHTemp::Api.

sample()

bool Driver::RHTemp::Simulated::Api::sample ( float &  rhOut, float &  tempCOut  )

virtualnoexcept

See Driver::RHTemp::Api.

Implements Driver::RHTemp::Api.

setHeaterState()

bool Driver::RHTemp::Simulated::Api::setHeaterState ( bool  enabled )

virtualnoexcept

See Driver::RHTemp::Api.

Reimplemented from Driver::RHTemp::Api.

start()

bool Driver::RHTemp::Simulated::Api::start ( )

virtualnoexcept

See Driver::RHTemp::Api.

Implements Driver::RHTemp::Api.

startSample()

Driver::RHTemp::Api::SamplingState_T Driver::RHTemp::Simulated::Api::startSample ( )

virtualnoexcept

See Driver::RHTemp::Api.

Implements Driver::RHTemp::Api.

stop()

void Driver::RHTemp::Simulated::Api::stop ( )

virtualnoexcept

See Driver::RHTemp::Api.

Implements Driver::RHTemp::Api.

Member Data Documentation

m_mpHeaterEnabled

Cpl::Dm::Mp::Bool& Driver::RHTemp::Simulated::Api::m_mpHeaterEnabled

protected

Simulated output value.

m_mpRh

Cpl::Dm::Mp::Float& Driver::RHTemp::Simulated::Api::m_mpRh

protected

Simulated input value.

m_mpTemp

Cpl::Dm::Mp::Float& Driver::RHTemp::Simulated::Api::m_mpTemp

protected

Simulated input value.

m_started

bool Driver::RHTemp::Simulated::Api::m_started

protected

Started state.

---

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

• Driver/RHTemp/Simulated/Api.h