#include <FiresPath.hpp>

Inheritance diagram for Fires::FiresPath:

Collaboration diagram for Fires::FiresPath:

[legend]

Public Types
enum	PropagationType { cUNDEFINED = 0 , cMAX_ORD_TOF = 1 , cELEVATION_TOF = 2 , cSIMPLE = 3 , cNUM_TYPES = 4 }

Public Member Functions
	FiresPath (WsfSimulation &aSimulation, UtStringId aType, WsfGeoPoint &aInitialLocation, double &aTargetRange, double &aTargetBearing, double aAzimuthError=0.0, double aElevationError=0.0)
	Constructor to be used independently of the FiresMover.
	FiresPath (WsfScenario &aScenario)
	Constructor used by the FiresMover.
	FiresPath (const FiresPath &aSrc)
virtual	~FiresPath ()=default
FiresPath &	operator= (const FiresPath &aSrc)=delete
void	SetImpactRange (double aRange)
	Set the ground impact range at which the munition will impact.
void	SetInitialBearing (double aBearing)
	Set the initial bearing along which the trajectory will move.
void	SetAzimuthError (double aAzimuthError)
void	SetElevationError (double aElevationError)
virtual bool	Initialize (double aSimTime)
double	GetImpactTime () const
void	GetState (double aSimTime, double aLocWCS[3], double aVelWCS[3])

Protected Member Functions
void	UpdateState (double aSimTime)
bool	PerformTrajectoryLookup ()
void	ComputeTargetRangeBearingDeltaAlt ()
bool	ComputeTrajectoryParameters ()
void	ComputeTimeConstantFromMaxOrd (double aDeltaAlt)
void	ComputeTimeConstantFromElevationAngle (double aDeltaAlt)
void	ComputeInitialVelocity (double aDeltaAlt)

Protected Attributes
PropagationType	mPropagationType
PropagationType	mSimplePropagationLookupType
WsfStringId	mFiresType
FiresTables *	mFiresTablesPtr
WsfSimulation *	mSimulationPtr
bool	mRemoveOnImpact
double	mImpactRange
double	mMaxHeight
	This is the independent variable (input) in the table lookup.
double	mElevationAngle
	Dependent variable of table lookup for max. ord lookups.
double	mImpactTime
	Dependent variable of table lookup for elevation lookups.
WsfGeoPoint	mInitialLocation
	Dependent variable of table lookup.
WsfGeoPoint	mImpactLocation
bool	mHasImpactLocation
bool	mConstrainPropagation
double	mInitialBearing
double	mBearingError
double	mElevationError
	Azimuth error for simulating dispersion of fires.
double	mDeltaAlt
	Elevation error for simulating dispersion of fires.
double	mSinB
	Difference between initial altitude and target alt.
double	mCosB
	Sine of initial bearing.
UtEntity	mGeom
	Cosine of initial bearing.
double	mLocWCS [3]
double	mVelWCS [3]
double	mVelNED [3]
double	mAccNED [3]
double	mRoll
double	mPitch
double	mHeading
double	mSimpleG
double	v0x
	The reduced value of the gravitational constant, used with simple propagation.
double	v0z
	The initial velocity parallel to the ground (vector connecting the initial and impact location).
double	mTimeConstant
	The initial velocity perpendicular to the ground (vector connecting the initial and impact location).
double	mInitialTime
	The approximation of the ballistic coefficient (the higher the time constant, the less drag).
bool	mDebug
	The sim time the round is fired.

Detailed Description

FiresPath implements the ballistic path used by WsfFiresMover. See AFSIM technical documentation for details.

Member Enumeration Documentation

◆ PropagationType

enum Fires::FiresPath::PropagationType

Enumerator
cUNDEFINED
cMAX_ORD_TOF
cELEVATION_TOF	Lookup Max ord and tof based on impact range.
cSIMPLE	Lookup Elevation and tof based on impact range.
cNUM_TYPES	whether to use a very simple parabolic trajectory, computed by using a reduced value of the gravitational constant to approximate drag

Constructor & Destructor Documentation

◆ FiresPath() [1/3]

Fires::FiresPath::FiresPath	(	WsfSimulation &	aSimulation,
		UtStringId	aType,
		WsfGeoPoint &	aInitialLocation,
		double &	aTargetRange,
		double &	aTargetBearing,
		double	aAzimuthError = 0.0,
		double	aElevationError = 0.0 )

Constructor to be used independently of the FiresMover.

References cUNDEFINED, WsfSimulation::GetScenario(), mBearingError, mConstrainPropagation, mCosB, mDebug, mDeltaAlt, mElevationAngle, mElevationError, mFiresTablesPtr, mFiresType, mHasImpactLocation, mHeading, mImpactLocation, mImpactRange, mImpactTime, mInitialBearing, mInitialLocation, mInitialTime, mMaxHeight, mPitch, mPropagationType, mRemoveOnImpact, mRoll, mSimpleG, mSimplePropagationLookupType, mSimulationPtr, mSinB, mTimeConstant, v0x, and v0z.

Referenced by Fires::FiresMover::FiresMover(), Fires::FiresMover::FiresMover(), FiresPath(), and operator=().

◆ FiresPath() [2/3]

Fires::FiresPath::FiresPath ( WsfScenario & aScenario )

explicit

Constructor used by the FiresMover.

References cUNDEFINED, WsfScenario::FindExtension(), mAccNED, mBearingError, mConstrainPropagation, mCosB, mDebug, mDeltaAlt, mElevationAngle, mElevationError, mFiresTablesPtr, mFiresType, mHasImpactLocation, mHeading, mImpactLocation, mImpactRange, mImpactTime, mInitialBearing, mInitialLocation, mInitialTime, mLocWCS, mMaxHeight, mPitch, mPropagationType, mRemoveOnImpact, mRoll, mSimpleG, mSimplePropagationLookupType, mSimulationPtr, mSinB, mTimeConstant, mVelNED, mVelWCS, v0x, and v0z.

◆ FiresPath() [3/3]

Fires::FiresPath::FiresPath ( const FiresPath & aSrc )

explicit

◆ ~FiresPath()

virtual Fires::FiresPath::~FiresPath ( )

virtualdefault

Member Function Documentation

◆ ComputeInitialVelocity()

void Fires::FiresPath::ComputeInitialVelocity ( double aDeltaAlt )

protected

References mImpactRange, mImpactTime, mTimeConstant, v0x, and v0z.

Referenced by ComputeTimeConstantFromElevationAngle(), and ComputeTimeConstantFromMaxOrd().

◆ ComputeTargetRangeBearingDeltaAlt()

void Fires::FiresPath::ComputeTargetRangeBearingDeltaAlt ( )

protected

Referenced by Fires::FiresMover::Initialize2().

◆ ComputeTimeConstantFromElevationAngle()

void Fires::FiresPath::ComputeTimeConstantFromElevationAngle ( double aDeltaAlt )

protected

References ComputeInitialVelocity(), mDebug, mElevationAngle, mImpactRange, mImpactTime, mMaxHeight, mSimpleG, mTimeConstant, v0x, and v0z.

Referenced by ComputeTrajectoryParameters().

◆ ComputeTimeConstantFromMaxOrd()

void Fires::FiresPath::ComputeTimeConstantFromMaxOrd ( double aDeltaAlt )

protected

References ComputeInitialVelocity(), mDebug, mElevationAngle, mFiresType, mImpactRange, mImpactTime, mMaxHeight, mSimpleG, mTimeConstant, v0x, and v0z.

Referenced by ComputeTrajectoryParameters().

◆ ComputeTrajectoryParameters()

bool Fires::FiresPath::ComputeTrajectoryParameters ( )

protected

Assuming this object was initialized with enough data, compute the remaining parameters to define the full trajectory for this munition.

References cELEVATION_TOF, cMAX_ORD_TOF, ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), cSIMPLE, mBearingError, mConstrainPropagation, mCosB, mDebug, mDeltaAlt, mElevationAngle, mElevationError, mFiresTablesPtr, mFiresType, mGeom, mHasImpactLocation, mImpactRange, mImpactTime, mInitialBearing, mInitialLocation, mMaxHeight, mPropagationType, mSimpleG, mSimulationPtr, mSinB, mTimeConstant, ok, PerformTrajectoryLookup(), v0x, and v0z.

Referenced by Initialize().

◆ GetImpactTime()

double Fires::FiresPath::GetImpactTime ( ) const

inline

References mImpactTime.

◆ GetState()

void Fires::FiresPath::GetState	(	double	aSimTime,
		double	aLocWCS[3],
		double	aVelWCS[3] )

Retrieve the state (position and velocity) at the given time.

Parameters

aSimTime	The time at which the state is desired.
aLocWCS	The location at the given time.
aVelWCS	The velocity at the given time.

References mLocWCS, mVelWCS, and UpdateState().

◆ Initialize()

bool Fires::FiresPath::Initialize ( double aSimTime )

virtual

References cELEVATION_TOF, cMAX_ORD_TOF, ComputeTrajectoryParameters(), cSIMPLE, cUNDEFINED, mFiresTablesPtr, mFiresType, mInitialTime, mPropagationType, mSimplePropagationLookupType, and ok.

Referenced by Fires::FiresMover::Initialize2().

◆ operator=()

FiresPath & Fires::FiresPath::operator= ( const FiresPath & aSrc )

delete

References FiresPath().

◆ PerformTrajectoryLookup()

bool Fires::FiresPath::PerformTrajectoryLookup ( )

protected

References cELEVATION_TOF, cMAX_ORD_TOF, mElevationAngle, mFiresTablesPtr, mFiresType, mImpactRange, mImpactTime, mMaxHeight, mPropagationType, mSimplePropagationLookupType, and ok.

Referenced by ComputeTrajectoryParameters().

◆ SetAzimuthError()

void Fires::FiresPath::SetAzimuthError ( double aAzimuthError )

inline

Set the initial error in elevation angle (used for dispersion of fires)

Note: This is not the expected value of the error but the actual error.

References mBearingError.

Referenced by Fires::FiresMover::Initialize2().

◆ SetElevationError()

void Fires::FiresPath::SetElevationError ( double aElevationError )

inline

Set the initial error in elevation angle (used for dispersion of fires)

Note: This is not the expected value of the error but the actual error.

References mElevationError.

Referenced by Fires::FiresMover::Initialize2().

◆ SetImpactRange()

void Fires::FiresPath::SetImpactRange ( double aRange )

inline

Set the ground impact range at which the munition will impact.

References mImpactRange.

◆ SetInitialBearing()

void Fires::FiresPath::SetInitialBearing ( double aBearing )

inline

Set the initial bearing along which the trajectory will move.

References mInitialBearing.

◆ UpdateState()

void Fires::FiresPath::UpdateState ( double aSimTime )

protected

Update the position and velocity of the munition to the given time.

Parameters

aSimTime The time to which the state is to be updated.

References cSIMPLE, mAccNED, mCosB, mGeom, mHeading, mInitialTime, mLocWCS, mPitch, mPropagationType, mRoll, mSimpleG, mSinB, mTimeConstant, mVelNED, mVelWCS, v0x, and v0z.

Referenced by GetState(), and Fires::FiresMover::Update().

Member Data Documentation

◆ mAccNED

double Fires::FiresPath::mAccNED[3]

protected

Referenced by FiresPath(), FiresPath(), Fires::FiresMover::Update(), and UpdateState().

◆ mBearingError

double Fires::FiresPath::mBearingError

protected

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and SetAzimuthError().

◆ mConstrainPropagation

bool Fires::FiresPath::mConstrainPropagation

protected

If the impact location is specified, range will be computed based on the initial location and impact location

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and Fires::FiresMover::ProcessInput().

◆ mCosB

double Fires::FiresPath::mCosB

protected

Sine of initial bearing.

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and UpdateState().

◆ mDebug

bool Fires::FiresPath::mDebug

protected

The sim time the round is fired.

Referenced by ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::ProcessInput(), and Fires::FiresMover::Update().

◆ mDeltaAlt

double Fires::FiresPath::mDeltaAlt

protected

Elevation error for simulating dispersion of fires.

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), and FiresPath().

◆ mElevationAngle

double Fires::FiresPath::mElevationAngle

protected

Dependent variable of table lookup for max. ord lookups.

Referenced by ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and PerformTrajectoryLookup().

◆ mElevationError

double Fires::FiresPath::mElevationError

protected

Azimuth error for simulating dispersion of fires.

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and SetElevationError().

◆ mFiresTablesPtr

FiresTables* Fires::FiresPath::mFiresTablesPtr

protected

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Initialize(), and PerformTrajectoryLookup().

◆ mFiresType

WsfStringId Fires::FiresPath::mFiresType

protected

Referenced by ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Initialize(), Fires::FiresMover::Initialize2(), and PerformTrajectoryLookup().

◆ mGeom

UtEntity Fires::FiresPath::mGeom

protected

Cosine of initial bearing.

Referenced by ComputeTrajectoryParameters(), FiresPath(), and UpdateState().

◆ mHasImpactLocation

bool Fires::FiresPath::mHasImpactLocation

protected

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::ProcessInput(), and Fires::FiresMover::Update().

◆ mHeading

double Fires::FiresPath::mHeading

protected

Referenced by FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::Update(), and UpdateState().

◆ mImpactLocation

WsfGeoPoint Fires::FiresPath::mImpactLocation

protected

Referenced by FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::ProcessInput(), and Fires::FiresMover::Update().

◆ mImpactRange

double Fires::FiresPath::mImpactRange

protected

Referenced by ComputeInitialVelocity(), ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), PerformTrajectoryLookup(), Fires::FiresMover::ProcessInput(), SetImpactRange(), and Fires::FiresMover::Update().

◆ mImpactTime

double Fires::FiresPath::mImpactTime

protected

Dependent variable of table lookup for elevation lookups.

Referenced by ComputeInitialVelocity(), ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), GetImpactTime(), PerformTrajectoryLookup(), and Fires::FiresMover::ProcessInput().

◆ mInitialBearing

double Fires::FiresPath::mInitialBearing

protected

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::ProcessInput(), and SetInitialBearing().

◆ mInitialLocation

WsfGeoPoint Fires::FiresPath::mInitialLocation

protected

Dependent variable of table lookup.

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and Fires::FiresMover::Update().

◆ mInitialTime

double Fires::FiresPath::mInitialTime

protected

The approximation of the ballistic coefficient (the higher the time constant, the less drag).

Referenced by FiresPath(), FiresPath(), FiresPath(), Initialize(), Fires::FiresMover::Update(), and UpdateState().

◆ mLocWCS

double Fires::FiresPath::mLocWCS[3]

protected

Referenced by FiresPath(), FiresPath(), GetState(), Fires::FiresMover::Update(), and UpdateState().

◆ mMaxHeight

double Fires::FiresPath::mMaxHeight

protected

This is the independent variable (input) in the table lookup.

Referenced by ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), PerformTrajectoryLookup(), and Fires::FiresMover::ProcessInput().

◆ mPitch

double Fires::FiresPath::mPitch

protected

Referenced by FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::Update(), and UpdateState().

◆ mPropagationType

PropagationType Fires::FiresPath::mPropagationType

protected

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Initialize(), PerformTrajectoryLookup(), Fires::FiresMover::ProcessInput(), and UpdateState().

◆ mRemoveOnImpact

bool Fires::FiresPath::mRemoveOnImpact

protected

Referenced by FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::ProcessInput(), and Fires::FiresMover::Update().

◆ mRoll

double Fires::FiresPath::mRoll

protected

Referenced by FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::Update(), and UpdateState().

◆ mSimpleG

double Fires::FiresPath::mSimpleG

protected

Referenced by ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and UpdateState().

◆ mSimplePropagationLookupType

PropagationType Fires::FiresPath::mSimplePropagationLookupType

protected

Referenced by FiresPath(), FiresPath(), FiresPath(), Initialize(), and PerformTrajectoryLookup().

◆ mSimulationPtr

WsfSimulation* Fires::FiresPath::mSimulationPtr

protected

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and Fires::FiresMover::Initialize2().

◆ mSinB

double Fires::FiresPath::mSinB

protected

Difference between initial altitude and target alt.

Referenced by ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and UpdateState().

◆ mTimeConstant

double Fires::FiresPath::mTimeConstant

protected

The initial velocity perpendicular to the ground (vector connecting the initial and impact location).

Referenced by ComputeInitialVelocity(), ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), Fires::FiresMover::ProcessInput(), and UpdateState().

◆ mVelNED

double Fires::FiresPath::mVelNED[3]

protected

Referenced by FiresPath(), FiresPath(), Fires::FiresMover::Update(), and UpdateState().

◆ mVelWCS

double Fires::FiresPath::mVelWCS[3]

protected

Referenced by FiresPath(), FiresPath(), GetState(), Fires::FiresMover::Update(), and UpdateState().

◆ v0x

double Fires::FiresPath::v0x

protected

The reduced value of the gravitational constant, used with simple propagation.

Referenced by ComputeInitialVelocity(), ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and UpdateState().

◆ v0z

double Fires::FiresPath::v0z

protected

The initial velocity parallel to the ground (vector connecting the initial and impact location).

Referenced by ComputeInitialVelocity(), ComputeTimeConstantFromElevationAngle(), ComputeTimeConstantFromMaxOrd(), ComputeTrajectoryParameters(), FiresPath(), FiresPath(), FiresPath(), and UpdateState().

The documentation for this class was generated from the following files:

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ PropagationType

Constructor & Destructor Documentation

◆ FiresPath() [1/3]

◆ FiresPath() [2/3]

◆ FiresPath() [3/3]

◆ ~FiresPath()

Member Function Documentation

◆ ComputeInitialVelocity()

◆ ComputeTargetRangeBearingDeltaAlt()

◆ ComputeTimeConstantFromElevationAngle()

◆ ComputeTimeConstantFromMaxOrd()

◆ ComputeTrajectoryParameters()

◆ GetImpactTime()

◆ GetState()

◆ Initialize()

◆ operator=()

◆ PerformTrajectoryLookup()

◆ SetAzimuthError()

◆ SetElevationError()

◆ SetImpactRange()

◆ SetInitialBearing()

◆ UpdateState()

Member Data Documentation

◆ mAccNED

◆ mBearingError

◆ mConstrainPropagation

◆ mCosB

◆ mDebug

◆ mDeltaAlt

◆ mElevationAngle

◆ mElevationError

◆ mFiresTablesPtr

◆ mFiresType

◆ mGeom

◆ mHasImpactLocation

◆ mHeading

◆ mImpactLocation

◆ mImpactRange

◆ mImpactTime

◆ mInitialBearing

◆ mInitialLocation

◆ mInitialTime

◆ mLocWCS

◆ mMaxHeight

◆ mPitch

◆ mPropagationType

◆ mRemoveOnImpact

◆ mRoll

◆ mSimpleG

◆ mSimplePropagationLookupType

◆ mSimulationPtr

◆ mSinB

◆ mTimeConstant

◆ mVelNED

◆ mVelWCS

◆ v0x

◆ v0z