// TODO the copyright will be added automatically

#ifndef _RESERVOIRS_H_
#define _RESERVOIRS_H_

#include "HDCommon.h"
#include "DGDefs.h"

/**
 *  @defgroup Reservoirs Reservoirs
 *  @brief Reservoir management module.
 *
 *  @addtogroup Reservoirs
 *  @{
 */

// ********** public definitions **********

#define DRAIN_RESERVOIR_TO_VOLUME_ML            0       ///< Drain reservoir to this volume (in mL) during treatment.
#define FILL_RESERVOIR_TO_VOLUME_ML             1500    ///< Fill reservoir to this volume (in mL) during treatment.

/// Reservoir management publish data structure
typedef struct
{
    U32 reservoirsExecState;                            ///< Reservoirs exec state.
    F32 activeReservoirUFVolML;                         ///< Active reservoir ultrafiltration volume milliliters.
    F32 activeReservoirVolSpentML;
    F32 dilLevelPct;
    F32 recircLevelPct;
    U32 timeDepletionMS;
    U32 timeWaitFillMS;
    F32 tempRemoveTragetFillFlow;

} RESERVOIRS_MANAGEMENT_DATA_T;

// ********** public function prototypes **********

void initReservoirs( void );

void resetReservoirsVariables( void );

void execReservoirs( void );

U32 getReservoirCycleTime( void );

/**@}*/

#endif