WSF
WsfATG_LaunchComputer Class Reference

#include <WsfATG_LaunchComputer.hpp>

Inheritance diagram for WsfATG_LaunchComputer:
Collaboration diagram for WsfATG_LaunchComputer:

Public Types

using ATGWeaponLARCollection = std::vector<WsfATG_WeaponLAR*>
Public Types inherited from WsfLaunchComputer
enum  Constraints {
  cMAX_DELTA_ALTITUDE , cMIN_DELTA_ALTITUDE , cMIN_OPENING_SPEED , cMAX_OPENING_SPEED ,
  cMAX_SLANT_RANGE , cMIN_SLANT_RANGE , cMAX_BORESIGHT_ANGLE , cNUMBER_OF_CONSTRAINTS
}
Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.

Public Member Functions

 WsfATG_LaunchComputer ()
 ~WsfATG_LaunchComputer () override
WsfLaunchComputerClone () const override
bool Initialize (double aSimTime, WsfWeapon *aWeaponPtr) override
bool ProcessInput (UtInput &aInput) override
void Update (double aSimTime) override
double EstimatedTimeToIntercept (double aSimTime, const WsfTrack &aTrack, double aLaunchDelayTime) override
void SelectLAR (double aLaunchAlt, double aLaunchSpeed)
 Select the LAR that most closely applies to the current launch condition, and use it.
const ATGWeaponLARCollectionGetWeaponLARs ()
int GetBestFitLAR_Index ()
WsfATG_WeaponLARGetBestFitLAR ()
Public Member Functions inherited from WsfLaunchComputer
 WsfLaunchComputer ()
 WsfLaunchComputer (const WsfLaunchComputer &aSrc)
 Copy constructor.
 ~WsfLaunchComputer () override=default
WsfLaunchComputeroperator= (const WsfLaunchComputer &)=delete
WsfLaunchComputerClone () const override
const char * GetScriptClassName () const override
bool ProcessInput (UtInput &aInput) override
WsfWeaponGetWeapon () const
 Return the weapon with which this launch computer is associated.
WsfPlatformGetPlatform () const
 Return the platform with which this launch computer is associated.
WsfSimulationGetSimulation () const
void SetMaximumDeltaAltitude (double aMaxDeltaAltitude)
void SetMinimumDeltaAltitude (double aMinDeltaAltitude)
void SetMaximumClosingSpeed (double aMaxClosingSpeed)
void SetMaximumOpeningSpeed (double aMaxOpeningSpeed)
void SetMinimumClosingSpeed (double aMinClosingSpeed)
void SetMinimumOpeningSpeed (double aMinOpeningSpeed)
void SetMaximumSlantRange (double aMaxRange)
void SetMinimumSlantRange (double aMinRange)
void SetMaximumOffBoresight (double aMaxAngle)
void SetMaximumTimeOfFlight (double aMaxTOF)
void SetThrustDuration (double aThrustTime)
void SetCoastDuration (double aCoastTime)
void SetBurnoutSpeed (double aBurnoutSpeed)
void SetMinTerminalSpeed (double aMinTerminalSpeed)
bool ComputerGenerationMode () const
void SetComputerGenerationMode (bool aComputerGenerationMode)
void CopyResultsToTrack (WsfTrack &aTrack)
bool HaveResultsFor (const WsfTrackId &aTrackId) const
bool HaveResultsFor (double aSimTime, const WsfTrackId &aTrackId, double &aTimeToIntercept) const
bool LaunchTimeIsValid () const
bool LauncherBearingIsValid () const
bool LauncherElevationIsValid () const
bool LoftAngleIsValid () const
bool BurnTimeIsValid () const
bool TimeOfFlightIsValid () const
bool InterceptTimeIsValid () const
bool InterceptPointIsValid () const
bool TargetImpactTimeIsValid () const
bool TargetImpactPointIsValid () const
bool EndTimeIsValid () const
bool EndPointIsValid () const
double GetLaunchTime () const
double GetLauncherBearing () const
double GetLauncherElevation () const
double GetLoftAngle () const
double GetBurnTime () const
double GetTimeOfFlight () const
double GetInterceptTime () const
const WsfGeoPointGetInterceptPoint () const
double GetTargetImpactTime () const
const WsfGeoPointGetTargetImpactPoint () const
double GetEndTime () const
const WsfGeoPointGetEndPoint () const
void SetInterceptTime (double aInterceptTime)
void SetInterceptPoint (const WsfGeoPoint &aInterceptPoint)
void SetInterceptPointWCS (const double aLocationWCS[])
void SetLaunchTime (double aLaunchTime)
void SetTimeOfFlight (double aTimeOfFlight)
void SetTargetImpactTime (double aImpactTime)
void SetLoftAngle (double aLoftAngle)
void SetBurnTime (double aBurnTime)
void SetLauncherBearing (double aBearing)
void SetLauncherElevation (double aElevation)
void SetTargetImpactPoint (const WsfGeoPoint &aImpactPoint)
void SetTargetImpactPointWCS (const double aLocationWCS[])
void SetEndTime (double aEndTime)
void SetEndPoint (const WsfGeoPoint &aLocation)
void SetEndPointWCS (const double aLocationWCS[])
void ClearCommandedValues ()
void SetCommandedLauncherBearing (double aBearing)
void SetCommandedLauncherElevation (double aElevation)
void SetCommandedLoftAngle (double aLoftAngle)
void SetCommandedBurnTime (double aBurnTime)
void SetCommandedInterceptPoint (const WsfGeoPoint &aPoint)
bool DebugEnabled () const
void SetDebugEnabled (bool aDebugEnabled)
bool ShowResults () const
Public Member Functions inherited from WsfObject
 WsfObject ()
 This is the constructor for the WsfObject class.
 ~WsfObject () override
 This is the destructor for the WsfObject class.
const char * GetScriptClassName () const override
const std::string & GetType () const
WsfStringId GetTypeId () const
 Get the string ID of the 'type' of the object.
void SetType (WsfStringId aType)
const std::string & GetBaseType () const
WsfStringId GetBaseTypeId () const
const TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (const WsfObject &aRhs)
 Assignment operator.
template<typename T>
void Serialize (T &aBuff)
 For XIO (de)serialization.
const std::string & GetName () const
WsfStringId GetNameId () const
void SetName (WsfStringId aName)

Static Public Member Functions

static std::string BaseTypeName ()
 The basic type name (needed by weapon_tools and launch computer processor).
Static Public Member Functions inherited from WsfLaunchComputer
static std::string BaseTypeName ()
static bool LoadInstance (UtInput &aInput, WsfLaunchComputer *&aLCPtr)
static bool GetLauncherBearing (const WsfTrack &aTrack, double &aBearing)
static bool GetLauncherElevation (const WsfTrack &aTrack, double &aElevation)
static bool GetLoftAngle (const WsfTrack &aTrack, double &aLoftAngle)
static bool GetBurnTime (const WsfTrack &aTrack, double &aBurnTime)
static bool GetInterceptTime (const WsfTrack &aTrack, double &aInterceptTime)
static bool GetInterceptPoint (const WsfTrack &aTrack, WsfGeoPoint &aPoint)

Protected Member Functions

 WsfATG_LaunchComputer (const WsfATG_LaunchComputer &aSrc)
WsfATG_LaunchComputeroperator= (const WsfATG_LaunchComputer &)=delete
bool InitializeTTIData () override
bool WithinConstraintsAt (double aSimTime, double aFutureInterceptTime, const WsfTrack &aTrack) override
Protected Member Functions inherited from WsfLaunchComputer
bool ResultIsValidFor (unsigned int aDataMask) const
void InitializeResults (double aSimTime, const WsfTrack &aTrack)
void UpdateResults (double aSimTime, double aTimeToIntercept, const WsfTrack &aTrack)
void ClearConstraints ()
void CopyConstraints (const bool aSrc[])
double ExpectedFlightDistance () const
double CurrentOpeningSpeed () const
bool DeltaAltitudeCheck (double aDeltaAltitude) const
bool SlantRangeCheck (double aSlantRange) const
bool BoresightAngleCheck (WsfPlatform *aPlatPtr, double aLocWCS[3]) const
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).

Additional Inherited Members

Static Public Attributes inherited from WsfLaunchComputer
static const double cFOREVER = 1.0E8
 Constant indicating a large amount of time, or "will never get there".
static const double cOUT_OF_REACH = 1.0E+30
 Constant indicating an unattainable distance, or "a long way away".
static const double cUNDEFINED_DOUBLE = 1.0E+30
 A constant indicating a value is undefined.
Protected Types inherited from WsfLaunchComputer
enum  {
  cVF_LAUNCH_TIME = 0X0001 , cVF_LAUNCHER_BEARING = 0X0002 , cVF_LAUNCHER_ELEVATION = 0X0004 , cVF_LOFT_ANGLE = 0X0008 ,
  cVF_BURN_TIME = 0X0010 , cVF_TIME_OF_FLIGHT = 0X0020 , cVF_INTERCEPT_TIME = 0X0040 , cVF_INTERCEPT_POINT = 0X0080 ,
  cVF_TARGET_IMPACT_TIME = 0X0100 , cVF_TARGET_IMPACT_POINT = 0X0200 , cVF_END_TIME = 0X0400 , cVF_END_POINT = 0X0800
}
static bool GetDataValue (const WsfTrack &aTrack, const std::string &aName, double &aValue, double aMultiplier)
WsfWeaponmWeaponPtr
bool mDebugEnabled
bool mShowResults
bool mComputerGenerationMode
bool mConstraintEnabled [cNUMBER_OF_CONSTRAINTS]
double mPredictionLockinTime
double mMaxDeltaAltitude
double mMinDeltaAltitude
double mMinOpeningSpeed
double mMaxOpeningSpeed
double mMaxSlantRange
double mMinSlantRange
double mCosineMaxBoresight
double mMaximumTOF
double mAvgThrustingAccel
double mBurnoutSpeed
double mBurnDuration
double mCoastTime
double mAvgCoastingAccel
double mMinTerminalSpeed
double mLastPredictionTime
WsfTrackId mLastPredictionTrackId
unsigned int mValidityFlags
double mLaunchTime
double mLauncherBearing
double mLauncherElevation
double mLoftAngle
double mBurnTime
double mTimeOfFlight
double mInterceptTime
WsfGeoPoint mInterceptPoint
double mTargetImpactTime
WsfGeoPoint mTargetImpactPoint
double mEndTime
WsfGeoPoint mEndPoint
double mCommandedLauncherBearing
double mCommandedLauncherElevation
double mCommandedLoftAngle
double mCommandedBurnTime
WsfGeoPoint mCommandedInterceptPoint

Detailed Description

Launch Computer which supplies information to launch an air to ground weapon. A WsfATG_LaunchComputer instance provides information used to launch a guided airborne weapon against a ground track. User input specifies the weapon type, a collection of one or more LARs to use in varying flight conditions, and one or more target track IDs. During flight, the LAR collection will be examined to choose the closest match to the current flight conditions. User stream input will configure the processor to run in Auto mode, against the current platform target, using a single specified weapon. After each firing, a flag must be re-set to allow the next subsequent shot (this prevents all ordinance from being expended upon a single target).

Member Typedef Documentation

◆ ATGWeaponLARCollection

Constructor & Destructor Documentation

◆ WsfATG_LaunchComputer() [1/2]

WsfATG_LaunchComputer::WsfATG_LaunchComputer ( )

◆ ~WsfATG_LaunchComputer()

WsfATG_LaunchComputer::~WsfATG_LaunchComputer ( )
override

◆ WsfATG_LaunchComputer() [2/2]

WsfATG_LaunchComputer::WsfATG_LaunchComputer ( const WsfATG_LaunchComputer & aSrc)
protected

Member Function Documentation

◆ BaseTypeName()

std::string WsfATG_LaunchComputer::BaseTypeName ( )
inlinestatic

The basic type name (needed by weapon_tools and launch computer processor).

Referenced by ATG_LAR_And_LC_Generator::WriteOutputFile(), and WsfLaunchComputerTypes::WsfLaunchComputerTypes().

◆ Clone()

WsfLaunchComputer * WsfATG_LaunchComputer::Clone ( ) const
overridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements WsfObject.

References WsfATG_LaunchComputer(), and WsfLaunchComputer::WsfLaunchComputer().

◆ EstimatedTimeToIntercept()

double WsfATG_LaunchComputer::EstimatedTimeToIntercept ( double aSimTime,
const WsfTrack & aTrack,
double aLaunchDelayTime )
overridevirtual

Determine the estimated time for the weapon to intercept a target.

Parameters
aSimTimeThe current simulation time.
aTrackThe track that represents the target.
aLaunchDelayTimeThe time it takes until the weapon will be launched.
Returns
The estimated time to intercept the target, or cFOREVER if no intercept is possible.

Reimplemented from WsfLaunchComputer.

References WsfLaunchComputer::cFOREVER, WsfLaunchComputer::InitializeResults(), WsfLaunchComputer::UpdateResults(), and WithinConstraintsAt().

◆ GetBestFitLAR()

WsfATG_WeaponLAR * WsfATG_LaunchComputer::GetBestFitLAR ( )
inline

◆ GetBestFitLAR_Index()

int WsfATG_LaunchComputer::GetBestFitLAR_Index ( )
inline

◆ GetWeaponLARs()

const ATGWeaponLARCollection & WsfATG_LaunchComputer::GetWeaponLARs ( )
inline

◆ Initialize()

bool WsfATG_LaunchComputer::Initialize ( double aSimTime,
WsfWeapon * aWeaponPtr )
overridevirtual

Initialize the object.

Parameters
aSimTimeThe current simulation time.
aWeaponPtrThe reference platform to use with default launch calculations.
Returns
'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfLaunchComputer.

References WsfLaunchComputer::ComputerGenerationMode(), WsfObject::GetName(), WsfLaunchComputer::GetPlatform(), WsfPlatformPart::GetSimulation(), WsfWeapon::GetUpdateInterval(), WsfLaunchComputer::Initialize(), and SelectLAR().

◆ InitializeTTIData()

bool WsfATG_LaunchComputer::InitializeTTIData ( )
overrideprotectedvirtual

Initialize Time To Intercept data for the object. If no TTI data is needed, then override method and simply return true.

Returns
'true' if successful or 'false' if some sort of error occurred.

Reimplemented from WsfLaunchComputer.

◆ operator=()

WsfATG_LaunchComputer & WsfATG_LaunchComputer::operator= ( const WsfATG_LaunchComputer & )
protecteddelete

◆ ProcessInput()

bool WsfATG_LaunchComputer::ProcessInput ( UtInput & aInput)
overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters
aInputa reference to a UtInput object.
Returns
'true' if the command was one recognized by the class or 'false' if not.
Exceptions
UtInput::ExceptionBase(or an object derived from it) if the command was recognized but contains some sort of error.
Note
If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from WsfObject.

References WsfLaunchComputer::ProcessInput().

◆ SelectLAR()

void WsfATG_LaunchComputer::SelectLAR ( double aLaunchAlt,
double aLaunchSpeed )

Select the LAR that most closely applies to the current launch condition, and use it.

Referenced by Initialize(), and Update().

◆ Update()

void WsfATG_LaunchComputer::Update ( double aSimTime)
overridevirtual

Reimplemented from WsfLaunchComputer.

References WsfLaunchComputer::GetPlatform(), and SelectLAR().

◆ WithinConstraintsAt()

bool WsfATG_LaunchComputer::WithinConstraintsAt ( double aSimTime,
double aFutureInterceptTime,
const WsfTrack & aTrack )
overrideprotectedvirtual

Evaluate whether the supplied WsfTrack currently passes the supplied constraints.

Parameters
aSimTimeCurrent time
aFutureInterceptTimePredicted future time of intercept (aSimTime plus predicted time of flight of the weapon).
aTrackTrack to be extrapolated for intercept
Returns
true Indicates within constraints (intercept believed attainable)

Reimplemented from WsfLaunchComputer.

References WsfMeasurement::GetExtrapolatedLocationWCS(), WsfPlatformPart::GetPlatform(), WsfLaunchComputer::GetWeapon(), and WsfLaunchComputer::WithinConstraintsAt().

Referenced by EstimatedTimeToIntercept().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved