SetpointProfileRunner Class Reference

'Runs' a setpoint profile. More...

#include <SetpointProfileRunner.h>

Collaboration diagram for SetpointProfileRunner:

Public Member Functions
	SetpointProfileRunner (Humidistat *humidistat)
	Constructor.
void	toggle ()
	Toggle the run state.
void	setProfile (const etl::span< const Point > &profile)
	Set the profile.
void	update ()
	Run the profile (if running). Call this periodically.
bool	isRunning () const
	Get the run state.
size_t	getCurrentPoint () const
	Get the index of the current Point in the profile.

Private Attributes
Humidistat &	humidistat
etl::span< const Point >	profile
uint32_t	timeStart
bool	running = false

Detailed Description

'Runs' a setpoint profile.

Definition at line 10 of file SetpointProfileRunner.h.

Constructor & Destructor Documentation

SetpointProfileRunner()

SetpointProfileRunner::SetpointProfileRunner ( Humidistat * humidistat )

explicit

Constructor.

Parameters

humidistat

Pointer to a Humidistat instance

Definition at line 3 of file SetpointProfileRunner.cpp.

Member Function Documentation

getCurrentPoint()

size_t SetpointProfileRunner::getCurrentPoint ( ) const

nodiscard

Get the index of the current Point in the profile.

Returns

index

Definition at line 32 of file SetpointProfileRunner.cpp.

Here is the caller graph for this function:

isRunning()

bool SetpointProfileRunner::isRunning ( ) const

nodiscard

Get the run state.

Returns

True if running

Definition at line 28 of file SetpointProfileRunner.cpp.

Here is the caller graph for this function:

setProfile()

void SetpointProfileRunner::setProfile

(

const etl::span< const Point > &

profile

)

Set the profile.

Parameters

profile

Span over Points

Definition at line 24 of file SetpointProfileRunner.cpp.

Here is the caller graph for this function:

toggle()

void SetpointProfileRunner::toggle

(

)

Toggle the run state.

Definition at line 19 of file SetpointProfileRunner.cpp.

Here is the caller graph for this function:

update()

void SetpointProfileRunner::update

(

)

Run the profile (if running). Call this periodically.

Definition at line 6 of file SetpointProfileRunner.cpp.

Here is the call graph for this function:

Member Data Documentation

humidistat

Humidistat& SetpointProfileRunner::humidistat

private

Definition at line 12 of file SetpointProfileRunner.h.

profile

etl::span<const Point> SetpointProfileRunner::profile

private

Definition at line 13 of file SetpointProfileRunner.h.

running

bool SetpointProfileRunner::running = false

private

Definition at line 15 of file SetpointProfileRunner.h.

timeStart

uint32_t SetpointProfileRunner::timeStart

private

Definition at line 14 of file SetpointProfileRunner.h.

---

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

• src/SetpointProfileRunner.h
• src/SetpointProfileRunner.cpp