File Producer.h¶

File List > include > Producer.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_PRODUCER_H
#define FLIR_SPINNAKER_PRODUCER_H

#include "Interface/IProducer.h"

namespace Spinnaker
{
    // Forward declaration of implementation class
    class IProducerImpl;

    class Producer : public IProducer
    {
        friend class SystemImpl;
        friend class InterfaceImpl;

      public:
        virtual ~Producer(void);

        virtual GenICam::gcstring GetProducerFilePath() const;

        virtual InterfaceList GetInterfaces(bool updateInterface = true);

        virtual bool UpdateInterfaceList();

        virtual CameraList GetCameras(bool updateInterfaces = true, bool updateCameras = true);

        virtual bool UpdateCameras(bool updateInterfaces = true);

        virtual GenApi::INodeMap& GetTLNodeMap() const;

        void RegisterEventHandler(EventHandler& evtHandlerToRegister, bool updateInterface = false);

        void UnregisterEventHandler(EventHandler& evtHandlerToUnregister);

        virtual void RegisterLoggingEventHandler(LoggingEventHandler& handler);

        virtual void UnregisterAllLoggingEventHandlers();

        virtual void UnregisterLoggingEventHandler(LoggingEventHandler& handler);

        virtual void SetLoggingCallbackPriorityLevel(SpinnakerLogLevel level);

        virtual SpinnakerLogLevel GetLoggingCallbackPriorityLevel();

        virtual bool IsInterfaceInUse();

        virtual bool IsCameraInUse();

        virtual 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);

      protected:
        Producer();

        virtual void StopInternalEventHandler();

        void ReleaseInstance();

      private:
        Producer(const Producer&);

        Producer& operator=(const Producer&);

        IProducerImpl* m_pProducerImpl;
    };

} // namespace Spinnaker

#endif // FLIR_SPINNAKER_PRODUCER_H