/**************************************************************************
*
* Copyright (c) 2025-2026 Diality Inc. - All Rights Reserved.
*
* THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN
* WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER.
*
* @file    StateTxHDF.h
*
* @author  (last)      Praneeth Bunne
* @date    (last)      27-May-2026
*
* @author  (original)  Sean Nash
* @date    (original)  21-Apr-2025
*
***************************************************************************/

#ifndef __STATE_TX_HDF_H__
#define __STATE_TX_HDF_H__

#include "TDCommon.h"
#include "TDDefs.h"

/**
 *  @defgroup StateTxHDF StateTxHDF
 *  @brief Treatment mode HDF state unit. The HDF sub-mode is where
 *  HDF and (optionally) ultrafiltration are being provided by the system.
 *  Heparin is added to the blood when appropriate.
 *
 *  @addtogroup StateTxHDF
 *  @{
 */

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

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

void initHDF( void );                                      // Initialize this unit
void transitionToHDF( void );                              // Prepares for transition to treatment HDF state
void execHDF( void );                                      // Execute the treatment HDF state machine

void pauseHDF( void );                                     // Pauses HDF due to alarm

HDF_STATE_T getHDFState( void );                      // Gets current HDF state
F32  getHDFUltrafiltrationVolumeDrawn( void );                     // Gets current total ultrafiltration volume drawn from patient.

void setHDFBloodPumpFlowRate( U32 bPFlow );                // Signal new BP flow rate
void setHDFDDParams( U32 qd, F32 ufVol, F32 quf );         // Signal new DD params

BOOL signalHDFPauseResumeUF( MESSAGE_T *message );                 // Handles a user request to pause or resume ultrafiltration
BOOL signalHDFFluidBolusRequest( void );                   // Fluid Bolus request from UI

/**@}*/

#endif