/**************************************************************************
*
* Copyright (c) 2024-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    FlushFilter.h
*
* @author  (last)      Michael Garthwaite
* @date    (last)      03-Mar-2025
*
* @author  (original)  Michael Garthwaite
* @date    (original)  03-Mar-2025
*
***************************************************************************/

#ifndef __FLUSH_FILTER_H__
#define __FLUSH_FILTER_H__

#include "FPCommon.h"
#include "FPDefs.h"

/**
 *  @defgroup FPFilterFlush FPFilterFlush
 *  @brief Filter Flush unit. Manages filter flush functions via a state machine.
 *
 *  @addtogroup FPFilterFlush
 *  @{
 */

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

/// Filter Flush data structure
typedef struct
{
    U32 filterFlushExecState;                                   ///< Filter Flush execution state
} FILTER_FLUSH_DATA_T;

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

void initFilterFlush( void );                                   // Initialize this Filter Flush unit
U32  transitionToFilterFlush( void );                           // Transition to Filter Flush
void execFilterFlush( void );                                   // Execute the Filter Flush state machine
BOOL isFilterFlushComplete( void );                             // returns if flush is complete
void signalStartFilterFlush( void );                            // signal to start flush
void resetFilterFlushSignals( void );                           // reset signals for flush

FP_FILTER_FLUSH_STATE_T getCurrentFilterFlushState( void );     // Get the current state of the Filter Flush

BOOL testFilterFlushDataPublishIntervalOverride( MESSAGE_T *message );
BOOL testFilterFlushTimerOverride( MESSAGE_T *message );
/**@}*/


#endif