/**************************************************************************
*
* Copyright (c) 2021-2023 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    TreatmentEnd.h
*
* @author  (last)      Sean Nash
* @date    (last)      18-Feb-2021
*
* @author  (original)  Sean Nash
* @date    (original)  05-Feb-2021
*
***************************************************************************/

#ifndef __TREATMENT_END_H__
#define __TREATMENT_END_H__

#include "HDCommon.h"
#include "HDDefs.h"

/**
 *  @defgroup TreatmentEnd TreatmentEnd
 *  @brief Treatment end sub-mode of treatment mode.
 *  The treatment end state is where we go when treatment has completed.
 *  In this state, no more Heparin delivery and no more ultrafiltration.
 *  In this state, treatment is over.  No dialysis.  Dialyzer is bypassed.
 *  In this state, blood pump is slowed while we wait for user to initiate
 *  a final rinseback of blood.
 *
 *  @addtogroup TreatmentEnd
 *  @{
 */

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

void initTreatmentEnd( void );
void transitionToTreatmentEnd( void );
void execTreatmentEnd( void );

void signalTreatmentEndAlarmRinsebackUserAction( void );                                 // from user for alarm
void signalTreatmentEndAlarmEndTxUserAction( void );                                     // from user for alarm
void signalTreatmentEndUserAction( REQUESTED_TREATMENT_END_USER_ACTIONS_T action );      // from user
TREATMENT_END_STATE_T getCurrentTreatmentEndState( void );

/**@}*/

#endif