Config parameters for overriding a load. More...

#include <utils_dualtariff.h>

Public Member Functions
constexpr	pairForceLoad ()=default

constexpr	pairForceLoad (int16_t _iStartOffset)

constexpr	pairForceLoad (int16_t _iStartOffset, uint16_t _uiDuration)

constexpr uint16_t	getDuration () const

constexpr int16_t	getStartOffset () const

Private Attributes
int16_t	iStartOffset { 0 }

uint16_t	uiDuration { UINT16_MAX }

Detailed Description

Config parameters for overriding a load.

This class allows the user to define when and how long a load will be forced at full power during off-peak period.

For each load, the user defines a pair of values: pairForceLoad => { offset, duration }. The load will be started with full power at ('start_offpeak' + 'offset') for a duration of 'duration'

all values are in hours (if between -24 and 24) or in minutes.
if the offset is negative, it's calculated from the end of the off-peak period (ie -3 means 3 hours back from the end).
to leave the load at full power till the end of the off-peak period, set the duration to 'UINT16_MAX' (somehow infinite time)

Definition at line 27 of file utils_dualtariff.h.

Constructor & Destructor Documentation

◆ pairForceLoad() [1/3]

pairForceLoad::pairForceLoad ( )

constexprdefault

◆ pairForceLoad() [2/3]

pairForceLoad::pairForceLoad ( int16_t _iStartOffset )

inlineexplicitconstexpr

Definition at line 31 of file utils_dualtariff.h.

◆ pairForceLoad() [3/3]

pairForceLoad::pairForceLoad	(	int16_t	_iStartOffset,
		uint16_t	_uiDuration )

inlineconstexpr

Definition at line 35 of file utils_dualtariff.h.

Member Function Documentation

◆ getDuration()

uint16_t pairForceLoad::getDuration ( ) const

inlinenodiscardconstexpr

Definition at line 44 of file utils_dualtariff.h.

◆ getStartOffset()

int16_t pairForceLoad::getStartOffset ( ) const

inlinenodiscardconstexpr

Definition at line 40 of file utils_dualtariff.h.

Member Data Documentation

◆ iStartOffset

int16_t pairForceLoad::iStartOffset { 0 }

private

the start offset from the off-peak begin in hours or minutes

Definition at line 50 of file utils_dualtariff.h.

◆ uiDuration

uint16_t pairForceLoad::uiDuration { UINT16_MAX }