File StructPort.h¶

File List > include > SpinGenApi > StructPort.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_STRUCTPORT_H
#define SPINNAKER_GENAPI_STRUCTPORT_H

#include "SpinGenApi/PortImpl.h"

namespace Spinnaker
{
    namespace GenApi
    {
        template <class CDataStruct> class CTestPortStruct : public CDataStruct, public CPortImpl
        {
          public:
            CTestPortStruct(int64_t BaseAddress = 0) : m_BaseAddress(BaseAddress)
            {
                MemSet(0);
                ResetStatistics();
            }

            //-------------------------------------------------------------
            // IBase implementation
            //-------------------------------------------------------------
            virtual EAccessMode GetAccessMode() const
            {
                return RW;
            }

            virtual EInterfaceType GetPrincipalInterfaceType() const
            {
                return intfIPort;
            }

            //---------------------------------------------------------------
            // IPort implementation
            //---------------------------------------------------------------

            virtual void Read(void* pBuffer, int64_t Address, int64_t Length)
            {
                int64_t InternalAddress = Address - m_BaseAddress;

                CDataStruct* pDataStruct = static_cast<CDataStruct*>(this);
                if (InternalAddress < 0 || Length < 0 || InternalAddress + Length > sizeof(CDataStruct))
                {
                    // throw RUNTIME_EXCEPTION("CTestPortStruct::Read - Invalid address and/or length");
                }
                memcpy(pBuffer, (uint8_t*)pDataStruct + InternalAddress, (size_t)Length);
                m_NumReads++;
            }

            virtual void Write(const void* pBuffer, int64_t Address, int64_t Length)
            {
                int64_t InternalAddress = Address - m_BaseAddress;

                CDataStruct* pDataStruct = static_cast<CDataStruct*>(this);
                if (InternalAddress < 0 || Length < 0 || InternalAddress + Length > sizeof(CDataStruct))
                {
                    // throw RUNTIME_EXCEPTION("CTestPortStruct::Write - Invalid address and/or length");
                }
                memcpy((uint8_t*)pDataStruct + InternalAddress, pBuffer, (size_t)Length);
                m_NumWrites++;
            }

            //-------------------------------------------------------------
            // Utility functions
            //-------------------------------------------------------------

            void MemSet(const char FillValue)
            {
                memset(static_cast<CDataStruct*>(this), FillValue, sizeof(CDataStruct));
            }

            //-------------------------------------------------------------
            // Statistics functions
            //-------------------------------------------------------------

            void ResetStatistics()
            {
                m_NumReads = 0;
                m_NumWrites = 0;
            }

            int64_t GetNumReads()
            {
                return m_NumReads;
            }

            int64_t GetNumWrites()
            {
                return m_NumWrites;
            }

          protected:
            int64_t m_NumReads;

            int64_t m_NumWrites;

            int64_t m_BaseAddress;
        };

    } // namespace GenApi
} // namespace Spinnaker

#endif // SPINNAKER_GENAPI_STRUCTPORT_H