Command_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Command_Base.h
//! @brief      ConOpSys command 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/Commands/Command_Base.h $
//!             $Revision: 2797 $
//!             $Date: 2021-07-12 16:13:33 +0500 (Mo, 12 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.
//
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Protecting header files from mutual, recursive inclusion.
//------------------------------------------------------------------------------
 
#pragma once
 
//------------------------------------------------------------------------------
// Include standard libraries header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include thrid party header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys header files
//------------------------------------------------------------------------------
 
#include "Application_Resource_Configuration.h"
#include "Protocol_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//! @brief Command type enumeration
enum class TCommand_Type : U8
{
 
  //! @brief Undefined command type
  e8_Undefined_Command = 0,
 
  //! @brief System embedded command type
  e8_System_Command = 1,
 
  //! @brief User application command type
  e8_Application_Command = 2
 
};
 
//------------------------------------------------------------------------------
// Class declaration
//------------------------------------------------------------------------------
 
//! @brief ConOpSys terminal command base class
class TCommand_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //--------------------------------------------------------------------------
    // Public defines
    //--------------------------------------------------------------------------
  
    //! @brief Command descriptor structure
    typedef struct
    {
 
      //! @brief Pointer to the command name
      C8 *c8_Command_Name;
 
      //! @brief Pointer to the command description text
      C8 *c8_Command_Description;
 
      //! @brief Command type
      TCommand_Type e8_Command_Type;
 
      //! @brief Pointer to the command object
      TCommand_Base *object_Command;
 
    } TCommand_Descriptor;
 
    //--------------------------------------------------------------------------
    // Public methods
    //--------------------------------------------------------------------------
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method.
    //! @note      None
    //! @param     [in] *struct_Descriptor - Pointer to the command description
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //! \par       UML diagram
    //! @dotfile   TCommand_Base__TCommand_Base.dt
    //--------------------------------------------------------------------------
 
    TCommand_Base( TCommand_Descriptor *struct_Descriptor );
 
    //!-------------------------------------------------------------------------
    //! @brief     Class distructor method.
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //! \par       UML diagram
    //! @dotfile   TCommand_Base___TCommand_Base.dt
    //--------------------------------------------------------------------------
 
    virtual ~TCommand_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Test command name
    //! @note      This method test command name against given name and returns status.
    //! @param     [in] *c8_Command_String - Pointer to the command string
    //! @return    BOOL - Command name test status
    //! @retval    false - Command not queal
    //! @retval    true - Command not queal
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommand_Base__Is_Command_Name.dt
    //--------------------------------------------------------------------------
 
    BOOL Is_Command_Name( C8 *c8_Command_String );
 
    //!-------------------------------------------------------------------------
    //! @brief     Execute command method
    //! @note      This method executes command specific functionality.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    BOOL - Command execution status
    //! @retval    false - Command execution failed
    //! @retval    true - Command execution successfull
    //! \par       Override
    //!            Required
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommand_Base__Execute.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Execute( TProtocol_Base *object_Protocol );
 
    //!-------------------------------------------------------------------------
    //! @brief     Send information about cpecific command over communication link protocol
    //! @note      This method sends information about specific command over specified communication link protocol.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommand_Base__Send_Information.dt
    //--------------------------------------------------------------------------
 
    VOID Send_Information( TProtocol_Base *object_Protocol );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
    //--------------------------------------------------------------------------
    // Private variables
    //--------------------------------------------------------------------------
 
    //! @brief Command descriptor storage
    TCommand_Descriptor *struct_Descriptor;
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------