/**
  * @RDE_HEADER@
  * Interface for LocationDisplay
  * $Id$
  * $HeadURL$
  * $Author$
  */

#pragma once

#include "situation_map_types.h"
#include <situation_map_export.h>
#include <QColor>

//----------------------------------------------------------------------------
namespace SituationMap
{

/**
 * @brief The class LocationDisplay enables access to the LocationDisplay.
 */
class SITUATIONMAP_EXPORT LocationDisplay
{

public:
  LocationDisplay()          = default;   ///< Contructor
  virtual ~LocationDisplay() = default;   ///< Destructor

  /**
   * @brief setCurrentLocation
   * @param currentLocation to be displayed
   * @param horizontalAccuracy The horizontal accuracy in meters. Positive values or NaN are supported
   * @param velocity The location's velocity in meters per second, 0 => no heading visible
   * @param course The location's course in degrees (clockwise), 0 being true North.
   * @return true on success, otherwise false
   */
  virtual bool setCurrentLocation(const Point3D &currentLocation,
                                  double horizontalAccuracy = std::nan(""),
                                  double velocity = 0,
                                  double course = 0,
                                  bool lastKnown = false
                                  ) = 0;
  virtual bool setOutdated(bool lastKnown) = 0;
  virtual bool start() = 0;
  virtual void stop() = 0;
  virtual bool isStarted() = 0;
};

} // namespace SituationMap

//----------------------------------------------------------------------------