Command_Manager_Base.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       Command_Manager_Base.h
//! @brief      ConOpSys command manager 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/Command_Manager_Base.h $
//!             $Revision: 2581 $
//!             $Date: 2021-04-11 17:48:33 +0500 (So, 11 Apr 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 "Command_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys related commands headers
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//------------------------------------------------------------------------------
// Class definitions
//------------------------------------------------------------------------------
 
//! @brief ConOpSys terminal command manager base class
class TCommand_Manager_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @brief     Class constructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    TCommand_Manager_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Class destructor method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual ~TCommand_Manager_Base();
 
    //!-------------------------------------------------------------------------
    //! @brief     Command manager initialisation method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Init();
 
    //!-------------------------------------------------------------------------
    //! @brief     Command manager finalisation method
    //! @note      None
    //! \par       Override
    //!            Not allowed
    //! @attention Don't call this method directly.
    //--------------------------------------------------------------------------
 
    virtual VOID Done();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get command object index referenced by command object pointer
    //! @note      This method allows resovle command manager storage index of the command
    //! @param     [out] *u32_Storage_Index - Command manager storage index
    //! @param     [in] *object_Command - Pointer to the command object
    //! @return    BOOL - Execution status
    //! @retval    false - Command object not found in command manager storage
    //! @retval    true - Command object found in command manager storage
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Index( U32 *u32_Storage_Index, TCommand_Base *object_Command );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get pointer to the command object referenced by command manager storage index
    //! @note      None
    //! @param     [in] u32_Storage_Index - Command manager storage index
    //! @param     [out] **object_Command - Pointer to the command object
    //! @return    BOOL - Execution status
    //! @retval    false - Command object not found in command manager storage
    //! @retval    true - Command object found in command manager storage
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Get_Command_By_Storage_Index( U32 u32_Storage_Index, TCommand_Base **object_Command );
 
    //!-------------------------------------------------------------------------
    //! @brief     Test for command registered in command manager
    //! @note      None
    //! @param     [in] *object_Command - Pointer to the command object
    //! @return    BOOL - Execution status
    //! @retval    false - Command object not registered in command manager storage
    //! @retval    true - Command object registered in command manager storage
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Is_Registered( TCommand_Base *object_Command );
 
    //!-------------------------------------------------------------------------
    //! @brief     Performs registration of the command in command manager
    //! @note      None
    //! @param     [in] *object_Command - Pointer to the command object
    //! @return    BOOL - Execution status
    //! @retval    false - Command object registration successed
    //! @retval    true - Command object registration failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Register( TCommand_Base *object_Command );
 
    //!-------------------------------------------------------------------------
    //! @brief     Performs unregistration of the command in command manager
    //! @note      None
    //! @param     [in] *object_Command - Pointer to the command object
    //! @return    BOOL - Execution status
    //! @retval    false - Command object unregistration successed
    //! @retval    true - Command object unregistration failed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Unregister( TCommand_Base *object_Command );
 
    //!-------------------------------------------------------------------------
    //! @brief     Execute command method
    //! @note      None
    //! @param     [in] *c8_Command_String - Pointer to the command name string
    //! @param     [in] *object_Protocol - Pointer to the communication protocol object
    //! @return    BOOL - Execution status
    //! @retval    false - Command name is not equal and command not executed
    //! @retval    true - Command name is equal and command executed
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Execute( C8 *c8_Command_String, TProtocol_Base *object_Protocol );
 
    //!-------------------------------------------------------------------------
    //! @brief     Get command count registered in command manager
    //! @note      None
    //! @return    U32 - Command count
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U32 Get_Command_Count();
 
    //!-------------------------------------------------------------------------
    //! @brief     Get command manager storage utilisation
    //! @note      None
    //! @param     [out] *u32_Command_Capacity - Pointer to the command manager capacity variable
    //! @param     [out] *u32_Command_Count - Pointer to the command count variable
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Get_Usage( U32 *u32_Command_Capacity, U32 *u32_Command_Count );
 
    //!-------------------------------------------------------------------------
    //! @brief     Send boot information message over given protocol
    //! @note      None
    //! @param     [in] *object_Protocol - Pointer to the protocol object
    //! @return    None
    //! \par       Override
    //!            Not allowed
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual VOID Show_Boot_Information( TProtocol_Base *object_Protocol );
 
    //!-------------------------------------------------------------------------
    //! @brief     This method return OS status
    //! @note      None
    //! @return    U32 - OS status
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual U32 Get_OS_Status();
 
    //!-------------------------------------------------------------------------
    //! @brief     This method set module in operation mode
    //! @note      None
    //! @return    BOOL - Module status
    //! @retval    false - Module in error mode
    //! @retval    true - Module ready to operations
    //! \par       Override
    //!            Required
    //! @attention None
    //--------------------------------------------------------------------------
 
    virtual BOOL Start_Operation();
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
 
    //! @brief Container for OS status
    TOS_Status_Structure struct_OS_Status;
 
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------