CArcAlertPacket.h

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcAlertPacket.h  ( GenIV )                                                                             |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the ARC device/controller exception packet class.                                    |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: August 14, 2014                                                             |
// |                                                                                                                  |
// |  Copyright 2014 Astronomical Research Cameras, Inc. All rights reserved.                                         |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
#ifdef _WINDOWS
    #pragma warning( disable: 4251 )
#endif
 
#include <cstdint>
#include <memory>
 
#include <CArcStatusPacket.h>
#include <CArcDeviceDllMain.h>
 
 
namespace arc
{
    namespace gen4
    {
 
        class GEN4_CARCDEVICE_API CArcAlertPacket final : public CArcStatusPacket
        {
            public:
 
                CArcAlertPacket( void );
 
                virtual ~CArcAlertPacket( void );
 
                bool headerValid( void ) const noexcept override;
 
                const std::string translate( void );
 
                const std::string getName( void ) const noexcept override;
 
                static constexpr std::uint32_t MAX_PACKET_SIZE = CArcPacket::MAX_PACKET_SIZE;
 
            protected:
 
                /* The packet payload id */
                static constexpr std::uint8_t PAYLOAD_ID = 0xAE;
 
                /* The packet data value to tell the driver to read from the alert register */
                static constexpr std::uint32_t READ_ALERT = 0x414C5254;
        };
 
    }   // end gen4 namespace
}       // end arc namespace
 
 
 
#ifndef DOXYGEN_SHOULD_SKIP_THIS
 
namespace std
{
    template<>
    class GEN4_CARCDEVICE_API default_delete< arc::gen4::CArcAlertPacket >
    {
        public:
 
            void operator()( arc::gen4::CArcAlertPacket* pObj );
    };
}
 
#endif      // DOXYGEN_SHOULD_SKIP_THIS