3-phase PV router
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | List of all members
pairForceLoad Class Reference

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'

Definition at line 27 of file utils_dualtariff.h.

Constructor & Destructor Documentation

◆ pairForceLoad() [1/3]

constexpr pairForceLoad::pairForceLoad ( )
constexprdefault

◆ pairForceLoad() [2/3]

constexpr pairForceLoad::pairForceLoad ( int16_t  _iStartOffset)
inlineexplicitconstexpr

Definition at line 31 of file utils_dualtariff.h.

◆ pairForceLoad() [3/3]

constexpr pairForceLoad::pairForceLoad ( int16_t  _iStartOffset,
uint16_t  _uiDuration 
)
inlineconstexpr

Definition at line 35 of file utils_dualtariff.h.

Member Function Documentation

◆ getDuration()

constexpr uint16_t pairForceLoad::getDuration ( ) const
inlineconstexpr

Definition at line 44 of file utils_dualtariff.h.

Here is the caller graph for this function:

◆ getStartOffset()

constexpr int16_t pairForceLoad::getStartOffset ( ) const
inlineconstexpr

Definition at line 40 of file utils_dualtariff.h.

Here is the caller graph for this function:

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 }
private

the duration for overriding the load in hours or minutes

Definition at line 51 of file utils_dualtariff.h.


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