adsbDataServiceInterface.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2022 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


#pragma once

#include "matrix/vlVector.h"
#include "vrfcore/vrfcoreDefines.h"
//#include <vrfutil/scriptGeometry.h>

#include <unordered_map>
#include <map>
#include <memory>
#include <set>

class DtVertexList;
class DtAdsbTrack;
class DtPathPoint; 




class DtAdsbTrackHandle
{
public:
  virtual ~DtAdsbTrackHandle() {};

   virtual bool isValid() const = 0;
   virtual int icaoAddress() const = 0;
   virtual std::string aircraftType() const = 0;
   virtual std::string tailNumber() const = 0;
   virtual double maxSpeedFlown() const = 0;
   virtual double maxAltitudeFlown() const = 0;//
   virtual double maxFlightDistance() const = 0;
   virtual bool isSquawkChanged(const double simTime) const = 0;

protected:
   DtAdsbTrackHandle() {};
};

typedef std::shared_ptr<DtAdsbTrackHandle> DtTrackHandlePtr;

class DtAdsbPathPointHandle
{
public:
   virtual ~DtAdsbPathPointHandle() {};

   virtual bool isValid() const = 0;
   virtual double timeStamp() const = 0;
   virtual double latitude() const = 0;
   virtual double longitude() const = 0;
   virtual double altitude() const = 0;
   virtual double speed() const = 0;
   virtual double heading() const = 0;
   virtual std::string callSign() const = 0;
   virtual std::string flightNumber() const = 0;
   virtual short squawkCode() const = 0;
   virtual bool isOnGround() const = 0;

   virtual int icaoAddress() const = 0;

   virtual DtAdsbPathPointHandle& operator++() = 0;

   virtual bool operator==(const DtAdsbPathPointHandle& other) const = 0;

protected:
   DtAdsbPathPointHandle() {};
};

typedef std::shared_ptr<DtAdsbPathPointHandle> DtPointHandlePtr;


class DT_DLL_vrfcore DtAdsbDataServiceInterface
{

public:

   using DtIcaoAddress = int;
   using DtIcaoAddrSet = std::set<DtIcaoAddress>;

   class DtAdsbDataJob
   {
   public:
      using Ptr = std::shared_ptr<DtAdsbDataJob>;

      DtAdsbDataJob() { };
      virtual ~DtAdsbDataJob() { };

      virtual bool complete() const = 0;

      virtual void tick() = 0;

      virtual bool success() const = 0;

      virtual void cancel() = 0;

      virtual const DtAdsbDataServiceInterface::DtIcaoAddrSet& tracks() const = 0;
   };

   DtAdsbDataServiceInterface() {};

   virtual ~DtAdsbDataServiceInterface() {};

   virtual bool isDataLoading() const = 0;

   virtual bool isFileLoadError() const = 0;

   virtual DtAdsbDataJob::Ptr findTracksInArea(const DtVertexList& areaVertices,
      bool unownedOnly = true) = 0;

   virtual DtAdsbDataJob::Ptr findTracksInAreaDuringTime(const DtVertexList & areaVertices,
      double startSimTime, double endSimTime, bool unownedOnly) = 0;

   virtual DtTrackHandlePtr trackHandleForAddress(DtIcaoAddress trackId) const = 0;

   virtual DtAdsbDataJob::Ptr requestOwnershipOfTracks(const DtIcaoAddrSet& trackIds,
      const double lastSimTime) = 0;

   virtual DtAdsbDataJob::Ptr releaseOwnershipOfTracks(const DtIcaoAddrSet& trackIds) = 0;

   virtual double adsbTimeFromSimTime(double simTime) const = 0;

   virtual std::string stringForEpochTime(double t) const = 0;

   virtual double simTimeFromAdsbTime(double adsbTime) const = 0;

   virtual double finalDataSimTime() const = 0;

   virtual DtPointHandlePtr firstPointAfterTime(
      const DtTrackHandlePtr track, double simTime) const = 0;

   virtual DtPointHandlePtr lastPointBeforeTime(
      const DtTrackHandlePtr track, double simTime) const = 0;

   virtual DtPointHandlePtr clonePoint(const DtPointHandlePtr p) const = 0;

   virtual void updateSquawkChangedTimestamp(const int icaoAddress, const double& simTime) = 0;

   virtual double barometricAltitudeAdjustment(const DtVector& localPosition, const double simTime) const = 0;

   virtual void resetData() = 0;

private:

   DtAdsbDataServiceInterface(const DtAdsbDataServiceInterface&);

   DtAdsbDataServiceInterface& operator=(const DtAdsbDataServiceInterface&);
};