WSF
WsfPath.hpp
Go to the documentation of this file.
1// ****************************************************************************
2// CUI
3//
4// The Advanced Framework for Simulation, Integration, and Modeling (AFSIM)
5//
6// Copyright 2003-2015 The Boeing Company. All rights reserved.
7//
8// The use, dissemination or disclosure of data in this file is subject to
9// limitation or restriction. See accompanying README and LICENSE for details.
10// ****************************************************************************
11// ****************************************************************************
12// Updated by Infoscitex, a DCS Company.
13// ****************************************************************************
14
15#ifndef WSFPATH_HPP
16#define WSFPATH_HPP
17
18#include "wsf_export.h"
19
20#include "UtMath.hpp"
21
26namespace WsfPath
27{
29constexpr double cDOUBLE_NOT_SET = -1.0E-12;
30
33
35constexpr double cUSE_DEFAULT = -1.0E-13;
36
39constexpr double cUSE_COMPUTED = -1.0E-14;
40
42constexpr double cNEGLIGIBLE_SPEED = 5280.0 / 3600.0 * UtMath::cM_PER_FT; // 1 mph to m/s
43
45constexpr double cHEADING_FUZZ = 5.0 * UtMath::cRAD_PER_DEG;
46
48constexpr double cGROUND_PROXIMITY_FUZZ = 4.0; // meters above ground
49
57
64
73
85
93
94WSF_EXPORT AltRef GetAltRef(AltRef aMoverDefault, AltRef aWaypointValue);
95
96}; // namespace WsfPath
97
98#endif
#define WSF_EXPORT
Definition WsfXIO_Export.hpp:35
Definition WsfPath.hpp:27
HdgRef
Heading reference option.
Definition WsfPath.hpp:60
@ cHDG_REF_RELATIVE
Implementation-defined (usually body-relative).
Definition WsfPath.hpp:62
@ cHDG_REF_NORTH
North-relative.
Definition WsfPath.hpp:61
constexpr double cUSE_COMPUTED
Definition WsfPath.hpp:39
constexpr double cGROUND_PROXIMITY_FUZZ
Height delta, above which we are considered airborne.
Definition WsfPath.hpp:48
AltRef
Altitude reference option.
Definition WsfPath.hpp:52
@ cALT_REF_AGL
Altitude is referenced to the terrain height.
Definition WsfPath.hpp:55
@ cALT_REF_MSL
Altitude is referenced to MSL.
Definition WsfPath.hpp:54
@ cALT_REF_MOVER_DEFAULT
Use the WsfMover altitude reference.
Definition WsfPath.hpp:53
constexpr double cUSE_PREVIOUS
A waypoint parameter with this value is a request to use the previously used value....
Definition WsfPath.hpp:32
TurnDirection
Turn direction for TurnToHeading and TurnToRelativeHeading.
Definition WsfPath.hpp:88
@ cTURN_DIR_LEFT
Turn to the left, even if right is closer.
Definition WsfPath.hpp:89
@ cTURN_DIR_SHORTEST
Turn in the direction that results in the shortest turn (DEFAULT).
Definition WsfPath.hpp:90
@ cTURN_DIR_RIGHT
Turn to the right, even if left is closer.
Definition WsfPath.hpp:91
constexpr double cHEADING_FUZZ
Heading error, below which we are considered to be on course (not turning).
Definition WsfPath.hpp:45
WSF_EXPORT AltRef GetAltRef(AltRef aMoverDefault, AltRef aWaypointValue)
Obtain the altitude reference, allowing for the WsfWaypoint value to override the WsfMover default.
Definition WsfPath.cpp:19
Switch
Option setting when to react as a WsfWaypoint is approached.
Definition WsfPath.hpp:76
@ cSWITCH_ON_PASSING
Switch only when abreast of the WsfWaypoint (DEFAULT).
Definition WsfPath.hpp:81
@ cSWITCH_ON_TIME
Switch when a specified time since the last WsfWaypoint has elapsed.
Definition WsfPath.hpp:78
@ cSWITCH_ON_APPROACH
Switch when approaching within one turn radius of the WsfWaypoint.
Definition WsfPath.hpp:80
@ cSWITCH_EXTERNAL
via software commands, or in script, or the path is being extrapolated.
Definition WsfPath.hpp:82
@ cSWITCH_ON_DISTANCE
Switch when a specified distance since last WsfWaypoint has passed.
Definition WsfPath.hpp:79
@ cSWITCH_MOVER_DEFAULT
Use the WsfMover switch setting.
Definition WsfPath.hpp:77
constexpr double cUSE_DEFAULT
A waypoint parameter with this value is a request to use the mover's default value....
Definition WsfPath.hpp:35
EndPath
End of-path option.
Definition WsfPath.hpp:67
@ cEP_MOVER_DEFAULT
Use the WsfMover end-of-path option.
Definition WsfPath.hpp:68
@ cEP_STOP
Stop at end-of-path.
Definition WsfPath.hpp:70
@ cEP_REMOVE
Remove the platform at end-of-path.
Definition WsfPath.hpp:71
@ cEP_EXTRAPOLATE
Extrapolate at end-of-path.
Definition WsfPath.hpp:69
constexpr double cDOUBLE_NOT_SET
Unique value, tested internally to see if a floating point value is set or defaulted.
Definition WsfPath.hpp:29
constexpr double cNEGLIGIBLE_SPEED
Speed below which an object is not considered to be moving:
Definition WsfPath.hpp:42
Copyrights Multiple, All Rights Reserved