File ManagedCameraBase.h

File List > SpinnakerNET > ManagedCameraBase.h

Go to the documentation of this file

//=============================================================================
// 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_MANAGED_CAMERABASE_H
#define FLIR_SPINNAKER_MANAGED_CAMERABASE_H

#include "CameraBase.h"
#include "IManagedCameraBase.h"
#include "ManagedImage.h"
#include "ManagedDeviceEventHandler.h"
#include "ManagedImageEventHandler.h"
#include "ManagedTransportLayerDefs.h"
#include "ManagedTransportLayerDevice.h"
#include "ManagedTransportLayerStream.h"

namespace SpinnakerNET
{
    public ref class ManagedCameraBase : IManagedCameraBase
    {
    public:
        virtual ~ManagedCameraBase();

        virtual SpinnakerNET::GenApi::INodeMap^ InitBase();

        virtual void DeInitBase();

        virtual bool IsInitialized();

        virtual bool IsValid();

        virtual SpinnakerNET::GenApi::INodeMap^ GetNodeMap();

        virtual SpinnakerNET::GenApi::INodeMap^ GetTLDeviceNodeMap();

        virtual SpinnakerNET::GenApi::INodeMap^ GetTLStreamNodeMap();

        virtual SpinnakerNET::GenApi::INodeMap^ GetTLStreamNodeMap(const int streamIndex);

        virtual SpinnakerNET::GenApi::AccessMode GetAccessMode();

        virtual void ReadPort(unsigned __int64 address, array<System::Byte>^ buffer, unsigned __int64 length);

        virtual void WritePort(unsigned __int64 address, array<System::Byte>^ buffer, unsigned __int64 length);

        virtual void BeginAcquisition();

        virtual void EndAcquisition();

        virtual BufferOwnership GetBufferOwnership();

        virtual void SetBufferOwnership(const BufferOwnership mode);

        virtual uint64_t GetUserBufferCount();

        virtual uint64_t GetUserBufferSize();

        virtual uint64_t GetUserBufferTotalSize();

        virtual void SetUserBuffers(IntPtr pMemBuffers, uint64_t totalSize);

        virtual void SetUserBuffers(array<IntPtr>^ ppMemBuffers, const uint64_t bufferCount, const uint64_t bufferSize);

        virtual IManagedImage^ GetNextImage();

        virtual IManagedImage^ GetNextImage(unsigned __int64 grabTimeout);

        virtual IManagedImage^ GetNextImage(unsigned __int64 grabTimeout, unsigned __int64 streamIndex);
        virtual IManagedImageList^ GetNextImageSync(unsigned __int64 grabTimeout);

        virtual ::System::String^ GetDeviceID();

        virtual ::System::String^ GetDeviceSerialNumber();

        [Obsolete("Use GetDeviceID() instead.")] virtual ::System::String^ GetUniqueID();

        virtual bool IsStreaming();

        virtual ::System::String^ GetGuiXml();

        virtual void RegisterEventHandler(ManagedEventHandler^ eventHandler);

#pragma warning(push)
#pragma warning(disable : 4947)
        [Obsolete("Use Node::Updated() event instead.")]
        virtual void RegisterEventHandler(ManagedDeviceEventHandler^ deviceEventHandler, String^ eventName);
#pragma warning(pop)

        virtual void RegisterEventHandler(ManagedImageEventHandler^ imageEventHandler, unsigned __int64 streamIndex);

        virtual void UnregisterEventHandler(ManagedEventHandler^ eventHandler);

        virtual unsigned int GetActiveNumDataStreams();

        virtual unsigned int GetNumDataStreams();

        virtual unsigned int DiscoverMaxPacketSize();

        virtual void ForceIP();

    internal:
        ManagedCameraBase();

        /*
        * Set camera from a native camera pointer
        */
        void SetBaseCamera(Spinnaker::CameraBase* baseCamera);

        Spinnaker::CameraBase* GetNativeCameraPtrBase();

    private:
        Spinnaker::CameraBase* m_pNativeCameraBase;
        unsigned char** m_ppUserNonContiguousBuffer;

    protected:
        SpinnakerNET::GenApi::NodeMap^ m_pNodeMap;
        SpinnakerNET::GenApi::NodeMap^ m_pGenTLNodeMap;
        List<SpinnakerNET::GenApi::NodeMap^> m_pStreamNodeMapList;

    public:
        ManagedTransportLayerDevice^ m_genTLDeviceInfo;
        List<ManagedTransportLayerStream^> m_genTLDataStreamInfoList;

        /*
        * Get vital camera information without connecting to the XML
        * through transport layer specific bootstrap registers.
        */
        virtual property SpinnakerNET::ManagedTransportLayerDevice^ TLDevice
        {
            SpinnakerNET::ManagedTransportLayerDevice^ get()
            {
                return m_genTLDeviceInfo;
            }
        }

        /*
        * Get vital dataStream information without connecting to the XML
        * through transport layer specific bootstrap registers.
        */
        virtual property SpinnakerNET::ManagedTransportLayerStream^ TLStream
        {
            SpinnakerNET::ManagedTransportLayerStream^ get()
            {
                return m_genTLDataStreamInfoList[0];
            }
        }
    };
}
#endif // FLIR_SPINNAKER_MANAGED_CAMERABASE_H