CArcImagePacket.h

 // +------------------------------------------------------------------------------------------------------------------+
 // |  FILE:  CArcImagePacket.h  ( GenIV )                                                                             |
 // +------------------------------------------------------------------------------------------------------------------+
 // |  PURPOSE: This file defines the ARC image packet.                                                                |
 // |                                                                                                                  |
 // |  AUTHOR:  Scott Streit            DATE: Mar 1, 2018                                                              |
 // |                                                                                                                  |
 // |  Copyright 2014 Astronomical Research Cameras, Inc. All rights reserved.                                         |
 // +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
#include <CArcPacket.h>
 
 
namespace arc
{
    namespace gen4
    {
 
        struct imagePacketHeader_t final
        {
            std::uint8_t  uiPayloadId;          
            std::uint8_t  uiReservedByte1;      
            std::uint8_t  uiReservedByte2;      
            std::uint8_t  uiPayloadLength;      
            std::uint32_t uiReserved;           
        };
 
 
        struct imageDataHeader_t final
        {
            std::uint16_t uwRow;            
            std::uint16_t uwChannel;        
            std::uint16_t uwCol;            
            std::uint16_t uwPixelCount;     
        };
 
 
        using dataSection_t = std::pair<imageDataHeader_t*, std::uint16_t*>;
 
 
 
        class GEN4_CARCDEVICE_API CArcImagePacket final : public CArcPacket
        {
            public:
 
                CArcImagePacket( void );
 
                CArcImagePacket( const CArcImagePacket& rPacket );
 
                virtual ~CArcImagePacket( void ) = default;
 
                virtual bool headerValid( void ) const noexcept override;
 
                bool endOfImage( void ) const noexcept;
 
                bool endOfImage( const imagePacketHeader_t* pHeader ) const noexcept;
 
                void assign( std::uint8_t* pData, std::uint32_t uiSize );
 
                void assign( void );
 
                bool hasMoreDataSections( void ) const noexcept;
 
                arc::gen4::dataSection_t getNextDataSection( void );
 
                const std::string getName( void ) const override;
 
                static constexpr std::uint16_t MAX_PACKET_SIZE = 1500;
 
                friend std::ostream& operator<<( std::ostream& tStream, const arc::gen4::CArcImagePacket& rPacket );
 
                void serialize( std::ostream& tStream );
 
                void deserialize( std::istream& tStream );
 
            protected:
 
                static constexpr std::uint8_t PAYLOAD_ID = 0xAA;
 
                static constexpr std::uint32_t EOI_RESERVED = 0x454F4949;
 
                imagePacketHeader_t* m_pHeader;
 
                imageDataHeader_t* m_pDataHeader;
 
                std::uint16_t* m_pNextDataSection;
 
                std::uint16_t* m_pPayload;
 
                std::uint16_t* m_pEndOfPacket;
 
                bool m_bHasMoreDataSections;
        };
 
 
        std::ostream& operator<<( std::ostream& tStream, const arc::gen4::CArcImagePacket& rPacket );
 
 
    }   // end gen4 namespace
}   // end arc namespace