aisDataServiceInterface.h

Go to the documentation of this file.

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


#pragma once

#include "vrfcore/vrfcoreDefines.h"

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

class DtVertexList;
class DtAisTrack;
class DtPathPoint;


class DT_DLL_vrfcore DtAisDataServiceInterface
{

public:

   using DtMmsi = int;
   using DtMmsiSet = std::set<DtMmsi>;
   using DtPathPoints = std::map<double, DtPathPoint>;
   using DtPathPointIter = std::map<double, DtPathPoint>::const_iterator;

   class DtAisDataJob
   {
   public:
      using Ptr = std::shared_ptr<DtAisDataJob>;
      using WeakPtr = std::weak_ptr<DtAisDataJob>;

      DtAisDataJob() { };
      virtual ~DtAisDataJob() { };

      virtual bool complete() const = 0;

      virtual void tick() = 0;

      virtual bool success() const = 0;

      virtual void cancel() = 0;

      virtual const DtAisDataServiceInterface::DtMmsiSet& tracks() const = 0;
   };

   DtAisDataServiceInterface() {};

   virtual ~DtAisDataServiceInterface() {};

   virtual bool isDataLoaded() const = 0;

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

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

   virtual const DtAisTrack* trackInfo(DtMmsi trackId) const = 0;

   virtual DtAisDataJob::Ptr requestOwnershipOfTracks(const DtMmsiSet& trackIds) = 0;

   virtual DtAisDataJob::Ptr releaseOwnershipOfTracks(const DtMmsiSet& trackIds) = 0;

   virtual double aisTimeFromSimTime(double simTime) const = 0;

   virtual double simTimeFromAisTime(double aisTime) const = 0;

   virtual double finalDataSimTime() const = 0;

   virtual bool getFirstPointAfterTime(const DtAisTrack& track, double simTime,
      DtPathPointIter& pathPointIter) const = 0;

   virtual bool getLastPointBeforeTime(const DtAisTrack& track, double simTime,
      DtPathPointIter& pathPointIter) const = 0;

   virtual DtPathPointIter getEndOfpath(const DtAisTrack& track) const = 0;

   virtual void resetData() = 0;

   virtual void clearData() = 0;

private:

   DtAisDataServiceInterface(const DtAisDataServiceInterface&);

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