ParametersUpdater Class Reference

Public Member Functions
void	AddParameter (Parameter *parameter)
void	AddUnitMonthlyOverride (float *target, const vecFloat *values)
void	Reset ()
void	DateUpdate (double date)
double	GetPreviousDate () const

Protected Member Functions
void	ChangingYear (double date)
void	ChangingMonth (double date)
void	ChangingDate (double date)

Member Function Documentation

AddParameter()

void ParametersUpdater::AddParameter

(

Parameter *

parameter

)

Add a parameter that needs to be updated over time.

Parameters

parameter

pointer to the parameter.

AddUnitMonthlyOverride()

void ParametersUpdater::AddUnitMonthlyOverride	(	float *	target,
		const vecFloat *	values )

Add a per-unit monthly parameter override (a parameter that is both spatial and monthly). The target holds the value the brick or process reads; it is rewritten with the month's entry at every month change.

Parameters

target	pointer to the per-unit value read by the brick or process.
values	pointer to the unit's 12 monthly values (January to December).

ChangingDate()

void ParametersUpdater::ChangingDate ( double date )

protected

Update the parameters for the new date.

Parameters

date	new date in MJD format.

ChangingMonth()

void ParametersUpdater::ChangingMonth ( double date )

protected

Update the parameters for the new month.

Parameters

date	new date in MJD format.

ChangingYear()

void ParametersUpdater::ChangingYear ( double date )

protected

Update the parameters for the new year.

Parameters

date	new date in MJD format.

DateUpdate()

void ParametersUpdater::DateUpdate

(

double

date

)

Update the parameters based on the current date.

Parameters

date	current date in MJD format.

GetPreviousDate()

double ParametersUpdater::GetPreviousDate ( ) const

inline

Get the previous date used for updating parameters.

Returns

previous date in MJD format.

Reset()

void ParametersUpdater::Reset

(

)

Clear the registered parameters and reset the previous date. Called before (re)registering parameters on each run (e.g. during calibration) so the same parameter is not registered several times and the start-date values are re-applied from a clean state.

---

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

• /github/workspace/core/src/base/ParametersUpdater.h
• /github/workspace/core/src/base/ParametersUpdater.cpp