LED_P017_39_KG3_CB.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      LED_P017_39_KG3_CB.h
//! @brief     P017.39 control board LED class header file.
//! @copyright ANVILEX LLC
//! @attention No special attention requered.
//!            $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Hardware/P017_39_KG3_CB/LED_P017_39_KG3_CB.h $
//!            $Revision: 2053 $
//!            $Date: 2020-09-06 02:16:27 +0500 (So, 06 Sep 2020) $
//!            $Author: minch $
//
// Copyright(C) 2015-2020 ANVILEX GmbH
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice,
//    this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
//    this list of conditions and the following disclaimer in the documentation
//    and/or other materials provided with the distribution.
//
// 3. Neither the name of ANVILEX nor the names of its contributors may be
//    used to endorse or promote products derived from this software without
//    specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// System LED unit
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
 
#include "System_Led_Base.h"
 
//------------------------------------------------------------------------------
// Class
//------------------------------------------------------------------------------
 
//! @brief P017.39 control board system LED class
class TLED_P017_39_KG3_CB : public TSystem_LED_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     System LED initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     System LED finalisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the alarm LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Alarm_On();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the alarm LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Alarm_Off();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the alarm LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Alarm_Toggle();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the run LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Run_On();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the run LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Run_Off();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the run LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Run_Toggle();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the ready LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Ready_On();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the ready LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Ready_Off();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the ready LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Ready_Toggle();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns on the error LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Error_On();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method turns off the error LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Error_Off();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method toggle the error LED.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Error_Toggle();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method return state of alarm LED.
    //! @note      None
    //! @return    BOOL - Alarm LED state
    //! @retval    false - Alarm LED is off
    //! @retval    true - Alarm LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Alarm_LED_State();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method return state of run LED.
    //! @note      None
    //! @return    BOOL - Run LED state
    //! @retval    false - Run LED is off
    //! @retval    true - Run LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Run_LED_State();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method return state of ready LED.
    //! @note      None
    //! @return    BOOL - Ready LED state
    //! @retval    false - Ready LED is off
    //! @retval    true - Ready LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Ready_LED_State();
 
    //!-------------------------------------------------------------------------
    //! @brief     Method return state of error LED.
    //! @note      None
    //! @return    BOOL - Error LED state
    //! @retval    false - Error LED is off
    //! @retval    true - Error LED is on
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Error_LED_State();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End Of File
//------------------------------------------------------------------------------