wizard/lib/source/map/Platform.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2018 Infoscitex, a DCS Company. All rights reserved.
//
// The use, dissemination or disclosure of data in this file is subject to
// limitation or restriction. See accompanying README and LICENSE for details.
// ****************************************************************************
 
#ifndef PLATFORM_HPP
#define PLATFORM_HPP
 
#include <QString>
#include <QTextCursor>
 
#include "UtCallbackHolder.hpp"
#include "ViExport.hpp"
#include "WkfPlatform.hpp"
#include "WsfPM_Platform.hpp"
#include "route/WkfAttachmentRoute.hpp"
#include "route/WkfRouteBrowserInterface.hpp"
 
namespace wizard
{
class ProxyChange;
class Editor;
 
struct QueuedOperation
{
   QString mPlatformName;
   QString mRouteName;
};
 
class VI_EXPORT Platform : public wkf::Platform
{
public:
   Platform(const std::string& aName, unsigned int aId, WsfPM_Platform& aPlatform);
   ~Platform() override;
 
   void GotoDefinition();
   const WsfPM_Platform& GetPlatform() const noexcept { return mPlatform; }
   WsfPM_Platform& GetPlatform() noexcept { return mPlatform; }
   bool            CheckPlatformDataChange(const QString& aDataName, const QString& aDataValue);
   void            PlatformInitialize();
 
   void                                                       RemovePlatformFromEditor();
   const std::vector<std::pair<Editor*, UtTextDocumentRange>> GetEditRanges();
   void UpdateRoute(const wkf::RouteBrowserInterface::RouteInfo& aRouteInfo);
 
   void AddNewRouteInText(const wkf::RouteBrowserInterface::RouteInfo& aRouteInfo);
   void AddQueuedOperation(int aIndex, bool aIsInsertion)
   {
      mQueuedOperations.emplace_back(std::pair<int, bool>(aIndex, aIsInsertion));
   }
   void RemoveWaypointFromEditor(wkf::AttachmentRoute* aRoutePtr, int aWaypointIndex = -1);

   const std::vector<unsigned int>& GetSelectedWaypoints() { return mSelectedWaypoints; }
   void                             ClearSelectedWaypoints() { mSelectedWaypoints.clear(); }
   void UpdateSelectedWaypoints(wkf::AttachmentRoute* aRoute) noexcept;
   void HandleQueuedDeleteWaypoint();
   void ResetDeletedIndex() { mWaitingForDelete = -1; }

   UtTextDocumentRange GetAttributeDocumentRange(WsfPProxyNode aAttrNode);
   UtTextDocumentRange GetAttributeRangeByName(const QString& aAttribute);
   void AddWaypointToEditor(const wkf::RouteBrowserInterface::WaypointInfo& aWaypointInfo, const int aWaypointIndex = -1);
 
   size_t GetDtedId() const { return mDtedId; }

   bool PlatformHasMover() const noexcept;

   bool IsRouteable() const noexcept;

   bool PlatformHasRoute() const noexcept;

   bool IsUsingGlobalRoute() const noexcept;

   WsfPM_Route GetProxyRoute() const noexcept;

   void Wrap() noexcept;

   void Unwrap() noexcept;

   bool IsWrapped() const noexcept;
 
private:
   void OnProxyModified(const ProxyChange& aProxyChange);
   void OnGlobalRouteListChange(const wizard::ProxyChange& aProxyChange);
   void ProxyUpdate();
   void SetupGroupings();
 
   bool CheckPositionChanged(const UtLatPos& aLatValue, const UtLonPos& aLonValue);
   bool CheckLatitudeChanged(const QString& aDataValue);
   bool CheckLongitudeChanged(const QString& aDataValue);
   bool CheckAltitudeChanged(const QString& aDataValue);
   bool CheckHeadingChanged();
   bool IsValidUnitForHeading(const QString& aUnitStr) const noexcept;
   bool CheckTypeChanged(const QString& aDataValue);
 
   void AttributeChanged(const QString& aDataName, const QString& aDataValue);
 
   void UpdatePlatformInTextEditor(const QString& aNewLine);
   void AddNewAttributeInText(const QString& aAttributeName, const QString& aDataValue);

   QString ConstructTextToAppendForPlatform(const QTextCursor& aStartCursor,
                                            const QTextCursor& aEndCursor,
                                            const QString&     aAttributeName,
                                            const QString&     aDataValue) const noexcept;
 
   void AddNewRouteInText(wkf::AttachmentRoute* aRoutePtr);
   void UpdateTextRange();
   void ReplaceTabs(QStringList& aList);

   void UpdateEditorInfo() noexcept;

   Editor* GetEditor() noexcept;
 
   unsigned int   mId;
   WsfPM_Platform mPlatform;
   size_t         mDtedId;
 
   Editor*             mEditorPtr             = nullptr;
   Editor*             mEditPlatformEditorPtr = nullptr;
   std::string         mFileName              = "";
   UtTextDocumentRange mPlatformTextRange;
 
   UtCallbackHolder mProxyCallbacks;
   bool             mDirty;
   bool             mWrapped;
   double           mSimTime;
   double           mLastLat;
   double           mLastLon;

   std::vector<std::pair<int, bool>> mQueuedOperations;
   int mWaitingForDelete; // index of a waypoint scheduled for deletion, -1 if no such waypoint exists
   std::vector<unsigned int> mSelectedWaypoints;
};
} // namespace wizard
 
VA_DECLARE_OBJECT_TYPE(wizard::Platform)
#endif