Function_Block_Switch_Button_Controller.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file      Function_Block_Switch_Button_Controller.h
//! @author    ANVILEX GmbH
//! @version   V1.0
//! @date      18.05.2016
//! @brief     Toggle button controller class header file.
//! @attention
//!
//! COPYRIGHT(C) 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.
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Function_Block_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Macros
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class declarations
//------------------------------------------------------------------------------
 
//! @brief Function block TFunction_Block_Switch_Button_Controller class declaration
class TFunction_Block_Switch_Button_Controller : public TFunction_Block_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TFunction_Block_Switch_Button_Controller();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TFunction_Block_Switch_Button_Controller();
 
    //!-------------------------------------------------------------------------
    //! @brief     Function block initialisation method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Init();
    
    //!-------------------------------------------------------------------------
    //! @brief     Function block execution method.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
    
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about Function block over communication link protocol
    //! @note      This method sends information about Function block over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Send_Information( TProtocol_Base *object_Protocol );
 
    //--------------------------------------------------------------------------
    // Function block parameter connectors
    //--------------------------------------------------------------------------
 
    //--------------------------------------------------------------------------
    // Function block input connectors
    //--------------------------------------------------------------------------
 
 
    //! @brief Block enable input signal (active high)
    TBlock_Input_Connector object_bool_Enable_Input;
    
    //! @brief Block toggle input signal (active high)
    TBlock_Input_Connector object_bool_Toggle_Input;
    
    //! @brief Block emergency stop input signal (active low)
    TBlock_Input_Connector object_bool_Emergency_Stop_Input;
    
    //! @brief Internal stop signal
    TBlock_Input_Connector object_bool_Internal_Stop_Input;
 
    //! @brief Press counter limit
    TBlock_Input_Connector object_U32_Press_Counter_Limit;
 
    //--------------------------------------------------------------------------
    // Function block output connectors
    //--------------------------------------------------------------------------
 
    //! @brief Block output signal
    TBlock_Output_Connector object_bool_Output;
    
    //! @brief Press state
    TBlock_Output_Connector object_bool_Output_Press_State;
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //! @brief Internal state
    BOOL bool_State = (BOOL)false;
 
    //! @brief Previous output state
    BOOL bool_Previous_Output_State = (BOOL)false;
 
    //! @brief New input state
    BOOL bool_New_Input_State = (BOOL)false;
 
    //! @brief Previous input state
    BOOL bool_Previous_Input_State = (BOOL)false;
    
    //! @brief Press counter
    U32 u32_Press_Count = (U32)0;
 
    //! @brief Button controller state definition
    typedef enum
    {
      
      //! @brief Pressed state
      enum_Pressed,
 
      //! @brief Not pressed state
      enum_Not_Pressed,
      
      //! @brief Ready state
      enum_Ready,
      
      //! @brief Press state
      enum_Press,
      
      //! @brief Error state
      enum_Error
      
    } TController_FSM_State;
    
    //! @brief Controller FSM state
    TController_FSM_State enum_Controller_FSM_State = TController_FSM_State::enum_Ready;
  
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------