Application_Task_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Application_Task_Base.h
//! @brief      ConOpSys application task base class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2015-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Engine/Application_Task_Base.h $
//!             $Revision: 2794 $
//!             $Date: 2021-07-11 04:06:01 +0500 (So, 11 Jul 2021) $
//!             $Author: minch $
//------------------------------------------------------------------------------
//
// 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.
//
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include system files
//------------------------------------------------------------------------------
 
#include "Defines.h"
//#include "Function_Block_Includes.h"
 
//------------------------------------------------------------------------------
 
//! @brief Application task state enumeration
typedef enum
{
 
  //! @brief Application task state is undefined
  state_Undefined = 0,
 
  //! @brief Application task is in initialising state
  state_Initialising = 1,
 
  //! @brief Application task is in error state
  state_Error = 2,
 
  //! @brief Application task is in inhibit state
  state_Inhibit = 3,
 
  //! @brief Application task is in ready state
  state_Ready = 4,
 
  //! @brief Application task is in transition state
  state_Transition = 5,
 
  //! @brief Application task is in standby state
  state_Standby = 6,
 
  //! @brief Application task is in operation state
  state_Operation = 7,
 
  //! @brief Application task is in fault state
  state_Fault = 8,
 
  //! @brief Application task is in reseting state
  state_Reseting = 9
 
} TApplication_Task_State;
 
//------------------------------------------------------------------------------
// Class definition
//------------------------------------------------------------------------------
 
//! @brief Application task base class
class TApplication_Task_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
/*
    //! @brief Application task state enumeration
    typedef enum
    {
    
      //! @brief Application task state is undefined
      state_Undefined = 0,
    
      //! @brief Application task is in initialising state
      state_Initialising = 1,
    
      //! @brief Application task is in error state
      state_Error = 2,
    
      //! @brief Application task is in inhibit state
      state_Inhibit = 3,
    
      //! @brief Application task is in ready state
      state_Ready = 4,
    
      //! @brief Application task is in transition state
      state_Transition = 5,
 
      //! @brief Application task is in standby state
      state_Standby = 6,
    
      //! @brief Application task is in operation state
      state_Operation = 7,
    
      //! @brief Application task is in fault state
      state_Fault = 8,
    
      //! @brief Application task is in reseting state
      state_Reseting = 9
 
    } TApplication_Task_State;
*/
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TApplication_Task_Base( U32 u32_New_Task_ID );
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TApplication_Task_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Performe interconnection of the function blocks within task.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
//    virtual VOID Connect();
 
    //!-------------------------------------------------------------------------
    //! @brief     Performed initialisation of the function blocks.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Performed cyclic execution of the function blocks.
    //! @note      None
    //! @return    None
    //! \par       Override
    //!            Optional
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Execute();
 
    //!-------------------------------------------------------------------------
    //! @brief     Returns status of the function block interconnection
    //! @note      None
    //! @return    BOOL - Interconnection status of the function blocks
    //! @retval    false - Function block has invalid interconnection
    //! @retval    true - Function block has valid interconnection
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    BOOL Is_Connected();
 
    //!-------------------------------------------------------------------------
    //! @brief     Returns task identifier
    //! @note      None
    //! @return    U32 - Task identifier
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    U32 Get_Task_ID();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //! @brief Create event method
    VOID Create_Event( U32 u32_Event_ID );
 
    //! @brief Task ID
    U32 u32_Task_ID;
 
    //! @brief Task sample time in seconds
    F32 f32_Sample_Time;
 
    //! @brief Connected status
    BOOL bool_Connected;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------