FrameDetector.hpp

Go to the documentation of this file.

// ======================================================================
// \title  FrameDetector.hpp
// \author mstarch
// \brief  hpp interface specification for FrameDetector
// ======================================================================
#ifndef SVC_FPRIME_FRAME_DETECTOR_HPP
#define SVC_FPRIME_FRAME_DETECTOR_HPP
#include <Fw/FPrimeBasicTypes.hpp>
#include <Utils/Types/CircularBuffer.hpp>

namespace Svc {

    class FrameDetector {
      public:
        enum Status {
            FRAME_DETECTED,    
            NO_FRAME_DETECTED, 
            MORE_DATA_NEEDED   
        };

        virtual ~FrameDetector() = default;

        virtual Status detect(const Types::CircularBuffer& data, FwSizeType& size_out) const = 0;
    };

} // Svc

#endif //SVC_FPRIME_FRAME_DETECTOR_HPP