File ChunkAdapter.h¶

File List > include > SpinGenApi > ChunkAdapter.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 SPINNAKER_GENAPI_CHUNKADAPTER_H
#define SPINNAKER_GENAPI_CHUNKADAPTER_H

#include "Types.h"
#include "INodeMap.h"

namespace Spinnaker
{
    namespace GenApi
    {
        typedef struct AttachStatistics_t
        {
            int NumChunkPorts;

            int NumChunks;

            int NumAttachedChunks;
        } AttachStatistics_t;

        class SPINNAKER_API CChunkAdapter
        {

          public:
            virtual ~CChunkAdapter();

            void AttachNodeMap(INodeMap* pNodeMap);

            void DetachNodeMap();

            // Implement that for a specific buffer layout
            virtual bool CheckBufferLayout(uint8_t* pBuffer, int64_t BufferLength) = 0;

            // Implement that for a specific buffer layout
            virtual void AttachBuffer(
                uint8_t* pBuffer,
                int64_t BufferLength,
                AttachStatistics_t* pAttachStatistics = NULL) = 0;

            void DetachBuffer();

            void UpdateBuffer(uint8_t* pBaseAddress);

            void ClearCaches();

          protected:
            CChunkAdapter(INodeMap* pNodeMap = NULL, int64_t MaxChunkCacheSize = -1);

            void* m_pChunkAdapter;
        };

    } // namespace GenApi
} // namespace Spinnaker

#endif // SPINNAKER_GENAPI_CHUNKADAPTER_H