WsfPM_Waypoint.hpp

Go to the documentation of this file.

// ****************************************************************************
// CUI
//
// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
//
// Copyright 2003-2015 The Boeing 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.
// ****************************************************************************
// ****************************************************************************
// Updated by Infoscitex, a DCS Company.
// ****************************************************************************
 
#ifndef WSFPM_WAYPOINT_HPP
#define WSFPM_WAYPOINT_HPP
 
#include "WsfPM_ObjectList.hpp"
#include "WsfPProxyBasicValues.hpp"
#include "WsfPProxyNode.hpp"
 
class WSF_PARSER_EXPORT WsfPM_Waypoint : public WsfPProxyNode
{
public:
   WsfPM_Waypoint();
   WsfPM_Waypoint(const WsfPProxyNode& aNode);
 
   enum WaypointType
   {
      cPOSITION,
      cOFFSET,
      cTURN,
      cOTHER
   };
 
   enum EndOfPathOption
   {
      cEP_DEFAULT,
      cEP_EXTRAPOLATE,
      cEP_STOP,
      cEP_REMOVE
   };
 
   enum TurnDirection
   {
      cTD_SHORTEST,
      cTD_LEFT,
      cTD_RIGHT
   };
 
   WaypointType GetWaypointType() const;
   WsfProxy::Position Position() const noexcept;
   WsfPProxyNode     PositionNode() const noexcept;
   WsfProxy::Speed   Speed() const;
   WsfProxy::Speed   ClimbRate() const;
   bool              UseDefaultClimbRate() const;
   WsfProxy::Speed   DiveRate() const;
   WsfProxy::Length  Altitude() const;
   WsfProxy::Length2 Offset() const;
   WsfProxy::Angle   HeadingChange() const;
   WsfProxy::Int GetAltitudeReference() const;
   wsf::proxy::AltitudeReferenceEnum AltitudeReferenceValue() const noexcept;
   EndOfPathOption                   EndOfPath() const;
   WsfProxy::Bool                    SwitchOnApproach() const;
   TurnDirection                     GetTurnDirection() const;
   WsfProxy::Acceleration            LinearAcceleration() const;
   bool                              UseDefaultLinearAcceleration() const;
   WsfProxy::Acceleration            RadialAcceleration() const;
   bool                              UseDefaultRadialAcceleration() const;
   WsfProxy::Angle                   BankAngleLimit() const;
   WsfProxy::Acceleration            TurnG_Limit() const;
   WsfProxy::Time                    PauseTime() const;
   WsfProxy::Length                  Distance() const;
   WsfProxy::Time                    Time() const;
   WsfProxy::Time*                   TimeToPoint() const { return GetValue().GetAttr("timeToPoint"); }
   WsfProxy::Angle Heading() const noexcept;
   WsfPProxyNode HeadingNode() const noexcept;
   std::string   ExecuteScript() const { return GetValue().GetAttr("executeScript").ValueToString(); }
   std::string   GotoLabel() const { return GetValue().GetAttr("gotoLabel").ValueToString(); }
   std::string   Label() const { return GetValue().GetAttr("label").ValueToString(); }
 
   bool SetWaypointType(WaypointType aType);
   bool SetAltitudeReference(const WsfProxy::Int& aAltRef);
   bool SetAltitudeReferenceValue(wsf::proxy::AltitudeReferenceEnum aVal) noexcept;
   bool SetAltitude(WsfProxy::Length aAltitude);
   bool SetPosition(WsfProxy::Position aPosition);
   bool SetOffset(WsfProxy::Length2 aOffset);
   bool SetTurnDirection(TurnDirection aDirection);
   bool SetGotoLabel(const std::string& aGoto);
   bool SetRadialAcceleration(WsfProxy::Acceleration aRadialAccel);
   bool SetEndOfPath(EndOfPathOption aEndOfPath);
   bool SetSwitchOnApproach(WsfProxy::Bool aSwitchOnApproach);
};
 
using WsfPM_WaypointList = WsfPM_ObjectList<WsfPM_Waypoint>;
 
namespace wsf
{
namespace proxy
{

std::string WSF_PARSER_EXPORT StringFromPosition(const WsfProxy::Position& aLatLon,
                                                 const WsfProxy::Length&   aAltitude,
                                                 const WsfProxy::Int&      aAltitudeRef) noexcept;

bool WSF_PARSER_EXPORT PositionFromString(const std::string&  aString,
                                          WsfProxy::Position& aLatLon,
                                          WsfProxy::Length&   aAltitude,
                                          WsfProxy::Int&      aAltitudeRef) noexcept;
 
} // namespace proxy
} // namespace wsf
#endif