CArcPacket.h

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcPacket.h  ( GenIV )                                                                                  |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the ARC device/controller packet class.                                              |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: March 20, 2014                                                              |
// |                                                                                                                  |
// |  Copyright 2014 Astronomical Research Cameras, Inc. All rights reserved.                                         |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
 
#ifdef _WINDOWS
    #pragma warning( disable: 4251 )
#endif
 
#include <string>
#include <cstdint>
#include <memory>
 
#include <CArcBase.h>
#include <CArcDeviceDllMain.h>
 
//#include <iostream>
 
namespace arc
{
    namespace gen4
    {
 
        struct packetHeader_t
        {
            std::uint8_t  uiPayloadId;          
            std::uint8_t  uiPacketId;           
            std::uint8_t  uiReservedByte;       
            std::uint8_t  uiPayloadLength;      
            std::uint32_t uiReserved;           
        };
 
 
        class GEN4_CARCDEVICE_API CArcPacket : public arc::gen4::CArcBase
        {
            public:
 
                virtual ~CArcPacket( void ) = default;
 
                virtual bool headerValid( void ) const noexcept = 0;
 
                constexpr std::uint32_t headerLength( void ) const noexcept
                {
                    return ( sizeof( packetHeader_t ) / sizeof( std::uint32_t ) );
                }
 
                constexpr std::uint32_t headerByteLength( void ) const noexcept
                {
                    return sizeof( packetHeader_t );
                }
 
                std::uint8_t packetId( void ) const;
 
                bool checkPacketId( std::uint32_t uiHeader, std::uint8_t uiPacketId ) const noexcept;
 
                std::uint8_t payloadId( void ) const;
 
                std::uint8_t payloadLength( void ) const;
 
                std::uint32_t payloadByteLength( void ) const;
 
                std::uint32_t* payload( void ) const noexcept;
 
                void add( const std::uint32_t uiValue );
 
                std::uint32_t length( void ) const noexcept;
 
                std::uint32_t byteLength( void ) const noexcept;
 
                std::uint32_t maxByteLength( void ) const noexcept;
 
                std::uint32_t maxLength( void ) const noexcept;
 
                std::uint32_t at( const std::uint32_t uiIndex ) const;
 
                std::uint32_t& operator [] ( const std::uint32_t uiIndex );
 
                std::uint8_t* data( void ) const noexcept;
 
                virtual const std::string getName( void ) const = 0;
 
                virtual const std::string toString( void ) const;
 
                virtual const std::string toLogString( void ) const;
 
            protected:
 
                CArcPacket( const std::uint32_t uiSize = MAX_PACKET_SIZE );
 
                void incrementLength( const std::uint8_t uiIncr = 1 ) noexcept;
 
                static constexpr auto MAX_PACKET_SIZE = static_cast< std::uint32_t >( 1024 );
 
                packetHeader_t* m_pHeader;
 
                std::uint32_t* m_pPayload;
 
                std::unique_ptr<std::uint8_t[]> m_pData;
 
                std::uint32_t m_uiSize;
        };
 
    }   // end gen4 namespace
}       // end arc namespace