System_Command_EVENTS.h

Go to the documentation of this file.

//------------------------------------------------------------------------------
//! @file       System_Command_EVENTS.h
//! @brief      ConOpSys terminal system command EVENTS class header file.
//! @attention  No special attention requered.
//! @copyright  (C) 2017-2020 ANVILEX LLC
//!             $HeadURL: https://192.168.3.4:8443/svn/P004_07/ConOpSys/Commands/System_Command_EVENTS.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 "Command_Base.h"
 
//------------------------------------------------------------------------------
// Include ConOpSys application header files
//------------------------------------------------------------------------------
 
//!-----------------------------------------------------------------------------
//! @brief ConOpSys terminal command EVENTS class
//------------------------------------------------------------------------------
 
class TCommand_EVENTS: public TCommand_Base
{
 
  //----------------------------------------------------------------------------
  // Public defines, methods and variables
  //----------------------------------------------------------------------------
 
  public:
 
    //!-------------------------------------------------------------------------
    //! @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_EVENTS__TCommand_EVENTS.dt
    //--------------------------------------------------------------------------
 
    explicit TCommand_EVENTS( TCommand_Descriptor *struct_Descriptor );
 
    //!-------------------------------------------------------------------------
    //! @brief     Execute command method
    //! @note      This method executes command specific functionality.
    //! @param     [in] *object_Protocol - Pointer to the communication link protocol
    //! \par       Override
    //!            Required
    //! @attention None
    //! \par       UML diagram
    //! @dotfile   TCommand_EVENTS__Execute.dt
    //--------------------------------------------------------------------------
 
    virtual VOID Execute( TProtocol_Base *object_Protocol );
 
  //----------------------------------------------------------------------------
  // Protected defines, methods and variables
  //----------------------------------------------------------------------------
 
  protected:
    
  //----------------------------------------------------------------------------
  // Private defines, methods and variables
  //----------------------------------------------------------------------------
 
  private:
 
};
 
//------------------------------------------------------------------------------
// Export references to the objects
//------------------------------------------------------------------------------
 
extern TCommand_EVENTS object_Command_EVENTS;
 
//------------------------------------------------------------------------------
// End of file
//------------------------------------------------------------------------------