#ifndef APP_MODES_OPERATIONMODES_H_
#define APP_MODES_OPERATIONMODES_H_

#include "ROCommon.h"
#include "RODefs.h"

/**
 *  @defgroup ROOperationModes ROOperationModes
 *  @brief Operation Modes unit.
 *
 *  @addtogroup ROOperationModes
 *  @{
 */

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

#define NO_SUB_STATE            0xFF        ///< value for when submode does not have specific substates and is not applicable.

/// Payload record structure for op mode broadcast message
typedef struct
{
    U32 opMode;                             ///< Current operating mode
    U32 subMode;                            ///< Current sub-mode of current operating mode
} OP_MODE_PAYLOAD_T;

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

void initOperationModes( void );                                    // Initialize this unit
void execOperationModes( void );

void requestNewOperationMode( RO_OP_MODE_T newMode );               // Request a transition to a new operation mode
RO_OP_MODE_T getCurrentOperationMode( void );                       // Get the current operation mode
RO_OP_MODE_T getPreviousOperationMode( void );                      // Get the previous operation mode
U32  getCurrentSubMode( void );                                     // Get the current sub-mode

/**@}*/

#endif