/**************************************************************************
*
* Copyright (c) 2025-2025 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    StateTxDialysis.h
*
* @author  (last)      Sean
* @date    (last)      15-Apr-2025
*
* @author  (original)  Sean
* @date    (original)  15-Apr-2025
*
***************************************************************************/

#ifndef __STATE_TX_DIALYSIS_H__
#define __STATE_TX_DIALYSIS_H__

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

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

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

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

void initDialysis( void );                                      // Initialize this unit
void transitionToDialysis( void );                              // Prepares for transition to treatment dialysis state
void execDialysis( void );                                      // Execute the treatment dialysis state machine

void pauseDialysis( void );                                     // Pauses dialysis due to alarm

DIALYSIS_STATE_T getDialysisState( void );                      // Gets current dialysis state
F32  getUltrafiltrationVolumeDrawn( void );                     // Gets current total ultrafiltration volume drawn from patient.

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

BOOL signalPauseResumeUF( MESSAGE_T *message );                 // Handles a user request to pause or resume ultrafiltration

/**@}*/

#endif