.. _program_listing_file__tmp_ws_src_ublox_ublox_gps_include_ublox_gps_worker.hpp:

Program Listing for File worker.hpp
===================================

|exhale_lsh| :ref:`Return to documentation for file <file__tmp_ws_src_ublox_ublox_gps_include_ublox_gps_worker.hpp>` (``/tmp/ws/src/ublox/ublox_gps/include/ublox_gps/worker.hpp``)

.. |exhale_lsh| unicode:: U+021B0 .. UPWARDS ARROW WITH TIP LEFTWARDS

.. code-block:: cpp

   //==============================================================================
   // Copyright (c) 2012, Johannes Meyer, TU Darmstadt
   // All rights reserved.
   
   // Redistribution and use in source and binary forms, with or without
   // modification, are permitted provided that the following conditions are met:
   //     * Redistributions of source code must retain the above copyright
   //       notice, this list of conditions and the following disclaimer.
   //     * Redistributions in binary form must reproduce the above copyright
   //       notice, this list of conditions and the following disclaimer in the
   //       documentation and/or other materials provided with the distribution.
   //     * Neither the name of the Flight Systems and Automatic Control group,
   //       TU Darmstadt, nor the names of its contributors may be used to
   //       endorse or promote products derived from this software without
   //       specific prior written permission.
   
   // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
   // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
   // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
   // ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
   // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
   // (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
   // LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
   // ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
   // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
   // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
   //==============================================================================
   
   #ifndef UBLOX_GPS_WORKER_HPP
   #define UBLOX_GPS_WORKER_HPP
   
   #include <chrono>
   #include <functional>
   
   namespace ublox_gps {
   
   // clang-tidy insists that we follow rule-of-5 for this abstract base class.
   // Generally we'd define the copy and move constructors as delete, but once
   // we do that we also have to explicitly define a default constructor (otherwise
   // it fails to compile).  That all works, but harms the readability of this
   // completely abstract base class (basically an interface), so we just disable
   // the checks for this class.
   class Worker {  // NOLINT(hicpp-special-member-functions, cppcoreguidelines-special-member-functions)
    public:
     using WorkerCallback = std::function<size_t(unsigned char*, std::size_t)>;
     using WorkerRawCallback = std::function<void(unsigned char*, std::size_t)>;
   
     virtual ~Worker() = default;
   
     virtual void setCallback(const WorkerCallback& callback) = 0;
   
     virtual void setRawDataCallback(const WorkerRawCallback& callback) = 0;
   
     virtual bool send(const unsigned char* data, const unsigned int size) = 0;
   
     virtual void wait(const std::chrono::milliseconds& timeout) = 0;
   
     virtual bool isOpen() const = 0;
   };
   
   }  // namespace ublox_gps
   
   #endif  // UBLOX_GPS_WORKER_HPP