//=============================================================================
// Copyright (c) 2001-2021 FLIR Systems, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef SPINNAKER_GENAPI_ICOMMAND_H
#define SPINNAKER_GENAPI_ICOMMAND_H

#include "SpinnakerPlatform.h"
#include "Types.h"
#include "IValue.h"

#ifdef _WIN32
#pragma warning(push)
#pragma warning(disable : 4251) // XXX needs to have dll-interface to be used by clients of class YYY
#endif

namespace Spinnaker
{
    namespace GenApi
    {
        /**
         *  @defgroup SpinnakerGenApiInterfaces Spinnaker GenApi Interfaces
         */
        /*@{*/

        /**
         *  @defgroup ICommand_h ICommand Interface
         */
        /*@{*/

        //*************************************************************
        // ICommand interface
        //*************************************************************

        /**
         * Interface for command like  properties
         */
        interface SPINNAKER_API_ABSTRACT ICommand : virtual public IValue
        {
          public:
            /**
             * Execute the command
             *
             * @param Verify Enables AccessMode and Range verification (default = true)
             */
            virtual void Execute(bool Verify = true) = 0;

            /**
             * Execute the command
             */
            virtual void operator()() = 0;

            /**
             * Query whether the command is executed
             *
             * @param Verify Enables Range verification (default = false). The AccessMode is always checked
             * @return True if the Execute command has finished; false otherwise
             */
            virtual bool IsDone(bool Verify = true) = 0;
        };

        /*@}*/
        /*@}*/
    } // namespace GenApi
} // namespace Spinnaker

#ifdef _WIN32
#pragma warning(pop)
#endif

#endif // ifndef SPINNAKER_GENAPI_ICOMMAND_H