/**************************************************************************
*
* Copyright (c) 2024-2024 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    TxParams.h
*
* @author  (last)      Sean
* @date    (last)
*
* @author  (original)  Sean
* @date    (original)  17-Nov-2025
*
***************************************************************************/

#ifndef APP_SERVICES_TX_PARAMS_H_
#define APP_SERVICES_TX_PARAMS_H_

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

/**
 *  @defgroup TxParams TxParams
 *  @brief Treatment parameters unit provides validation and confirmation handling for treatment parameters from the UI.
 *
 *  @addtogroup TxParams
 *  @{
 */

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

void resetTreatmentParameters( void );                            // Reset all parameters to defaults
void signalUserConfirmTreatmentParameters( MESSAGE_T *message );  // Process UI confirm/reject Treatment Parameters

BOOL validateAndSetTreatmentParameters( MESSAGE_T *message );     // Validate Treatment Parameters received from UI
BOOL validateAndSetUFVolume( MESSAGE_T *message );                // Validate UF volume received from UI

BOOL getValidTreatParamsReceived( void );                         // Determine whether valid Treatment Parameters exist
BOOL getTreatParamsConfirmed( void );                             // Determine whether user confirmed the parameters
BOOL getTreatParamsRejected( void );                              // Determine whether user rejected the parameters

/**@}*/

#endif