File Interface.h¶

File List > include > Interface.h
//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, 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 FLIR_SPINNAKER_INTERFACE_H
#define FLIR_SPINNAKER_INTERFACE_H

#include "Interface/IInterface.h"

namespace Spinnaker
{
    class SPINNAKER_API Interface : public IInterface
    {
      public:
        virtual ~Interface(void);

        CameraList GetCameras(bool updateCameras = true) const;

        ProducerPtr GetProducer() const;

        bool UpdateCameras();

        GenApi::INodeMap& GetTLNodeMap() const;

        void RegisterEventHandler(EventHandler& evtHandlerToRegister);

        void UnregisterEventHandler(EventHandler& evtHandlerToUnregister);

        void UnregisterAllLoggingEventHandlers();

        bool IsCameraInUse() const;

        void SendActionCommand(
            unsigned int deviceKey,
            unsigned int groupKey,
            unsigned int groupMask,
            unsigned long long actionTime = 0,
            bool requestAck = false,
            unsigned int* pResultSize = 0,
            ActionCommandResult results[] = NULL) const;

        bool IsValid();

      protected:
        friend class InterfaceInternal;

      private:
        /*
         * Default Constructor
         */
        Interface(void);

        /*
         * Copy Constructor
         */
        Interface(const Interface& /*iface*/);

        Interface& operator=(const Interface& /*iface*/);
    };

} // namespace Spinnaker

#endif // FLIR_SPINNAKER_INTERFACE_H