#include <ATG_LAR_And_LC_Generator.hpp>

Inheritance diagram for ATG_LAR_And_LC_Generator:

[legend]

Collaboration diagram for ATG_LAR_And_LC_Generator:

[legend]

Public Member Functions
	ATG_LAR_And_LC_Generator (WsfScenario &aScenario)
	ATG_LAR_And_LC_Generator (const ATG_LAR_And_LC_Generator &aSrc)
ATG_LAR_And_LC_Generator &	operator= (const ATG_LAR_And_LC_Generator &)=delete
	~ATG_LAR_And_LC_Generator () override=default
Tool *	Clone () const override
bool	Initialize (WsfSimulation &aSimulation) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override
Public Member Functions inherited from Tool
	Tool (const Tool &aSrc)
Tool &	operator= (const Tool &)=delete
	~Tool () override
bool	ProcessInput (UtInput &aInput) override
virtual void	MoverBurnout (double aSimTime, WsfMover *aMoverPtr)
	name Callbacks from WeaponObserver (lets the tool have access to simulation callbacks)
virtual void	GuidanceComputerPhaseChanged (double aSimTime, WsfGuidanceComputer *aComputerPtr)
	Optional tool method called by WeaponObserver to pass on the GuidanceComputerPhaseChanged simulation observer event.
virtual void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
	Optional tool method called by WeaponObserver to pass on the PlatformAdded simulation observer event.
WsfStringId	WeaponPlatformTypeId () const
double	FrameStep () const
bool	IsInitialized () const
WsfPlatform *	GetLauncherPlatform () const
WsfExplicitWeapon *	GetLauncherWeapon () 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 TypeList &	GetTypeList () const
bool	IsA_TypeOf (WsfStringId aType) const
WsfObject &	operator= (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)

Protected Member Functions
void	LARGenUpdate (double aSimTime)
void	SensitivityUpdate (double aSimTime)
bool	FireNewWeapon (double aSimTime) override
void	ErrorBailout () override
void	WriteOutputFile ()
Protected Member Functions inherited from Tool
WsfSimulation *	GetSimulation () const
WsfScenario &	GetScenario () const
ToolManager *	GetManager () const
	Tool (WsfScenario &aScenario)
	This constructor initializes the object.
void	UnInitialize ()
bool	IsDone () const
	Return a flag to indicate that this Tool has completed its work.
bool	DebugEnabled () const
	Return a flag to indicate that debugging is enabled.
virtual void	ResolveNames ()
	Method called to determine what the output objects and file names are called.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Protected Attributes inherited from Tool
WsfScenario *	mScenarioPtr
WsfSimulation *	mSimulationPtr
WeaponObserver	mObserver
WsfPlatform *	mLaunchPlatPtr
WsfExplicitWeapon *	mLaunchWpnPtr
double	mFrameStep
double	mLastUpdate
double	mLatDeg
double	mLonDeg
double	mAlt
double	mHeadingRad
bool	mDone
bool	mNotifiedDone
bool	mInitialized
bool	mDebug
bool	mTerminateOnLaunchFailure
std::string	mToolProduces
std::string	mFileExtension
WsfStringId	mWeaponEffectTypeId
WsfStringId	mLaunchPlatformTypeId
WsfStringId	mTargetPlatformTypeId
WsfStringId	mWeaponNameId
std::string	mOutputFileName
std::string	mOutputObjectName

Detailed Description

Air To Ground (ATG) Launch Acceptable Region (LAR) Generator Tool. ATG_LAR_And_LC_Generator is a Tool to compute the LAR for Air To Ground weapon. An instance will accept a defined glide-bomb-type guided weapon, dropping it at a specified altitude and speed against a ground target location. The target location will be varied with discrete longitudinal and lateral offsets from the launch point, and the hit / miss results will be saved in a matrix of boolean values. The tool will then attempt to produce a LAR in WsfZone format, within which there is a good probability of target intercept. For off-design launch conditions, the tool will also compute ballistic (no guidance) sensitivities for adjusting the LAR as a function of incremental altitude, speed, and loft (gamma climb angle). A shrink factor may be specified to shrink the LAR boundaries to incorporate conservatism for off-design conditions; it pulls the WsfZone boundary inward proportionally from the centroid of the LAR.

Constructor & Destructor Documentation

◆ ATG_LAR_And_LC_Generator() [1/2]

ATG_LAR_And_LC_Generator::ATG_LAR_And_LC_Generator ( WsfScenario & aScenario )

References Tool::mAlt, Tool::mToolProduces, and Tool::Tool().

Referenced by ATG_LAR_And_LC_Generator(), Clone(), and operator=().

◆ ATG_LAR_And_LC_Generator() [2/2]

ATG_LAR_And_LC_Generator::ATG_LAR_And_LC_Generator ( const ATG_LAR_And_LC_Generator & aSrc )

References ATG_LAR_And_LC_Generator(), and Tool::Tool().

◆ ~ATG_LAR_And_LC_Generator()

ATG_LAR_And_LC_Generator::~ATG_LAR_And_LC_Generator ( )

overridedefault

References LARGenUpdate(), SensitivityUpdate(), Tool::Tool(), and WriteOutputFile().

Member Function Documentation

◆ Clone()

Tool * ATG_LAR_And_LC_Generator::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 Tool.

References ATG_LAR_And_LC_Generator(), and Tool::Tool().

◆ ErrorBailout()

void ATG_LAR_And_LC_Generator::ErrorBailout ( )

overrideprotectedvirtual

Reimplemented from Tool.

References Tool::mDone, and Tool::mObserver.

Referenced by FireNewWeapon().

◆ FireNewWeapon()

bool ATG_LAR_And_LC_Generator::FireNewWeapon ( double aSimTime )

overrideprotectedvirtual

Method called to fire a new weapon. Pure virtual base method must be implemented in derived classes.

Parameters

aSimTime The current simulated time.

Implements Tool.

References ErrorBailout(), Tool::mHeadingRad, Tool::mLatDeg, Tool::mLaunchPlatPtr, Tool::mLaunchWpnPtr, Tool::mLonDeg, Tool::mObserver, Tool::mTerminateOnLaunchFailure, success, and vel.

Referenced by LARGenUpdate(), and SensitivityUpdate().

◆ Initialize()

bool ATG_LAR_And_LC_Generator::Initialize ( WsfSimulation & aSimulation )

overridevirtual

In another typical WSF construct, this method initializes the object prior to run time. If the Initialization fails, the object will not be permitted to transition to the run mode. Derived classes must assure that they are initialized internally, as well as calling the base class Initialize method.

Returns: Boolean success value.

Reimplemented from Tool.

References Tool::Initialize(), Tool::mInitialized, Tool::mOutputFileName, Tool::mTargetPlatformTypeId, Tool::mWeaponEffectTypeId, and Tool::UnInitialize().

◆ LARGenUpdate()

void ATG_LAR_And_LC_Generator::LARGenUpdate ( double aSimTime )

protected

References WeaponObserver::cIDLE, WeaponObserver::cTERMINATED, Tool::DebugEnabled(), WsfSimulation::DeletePlatform(), FireNewWeapon(), WsfScenario::GetAtmosphere(), WsfSimulation::GetPlatformByIndex(), Tool::GetScenario(), Tool::GetSimulation(), and Tool::mObserver.

Referenced by Update(), and ~ATG_LAR_And_LC_Generator().

◆ operator=()

ATG_LAR_And_LC_Generator & ATG_LAR_And_LC_Generator::operator= ( const ATG_LAR_And_LC_Generator & )

delete

References ATG_LAR_And_LC_Generator().

◆ ProcessInput()

bool ATG_LAR_And_LC_Generator::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

aInput a 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 WsfScenario::FromInput(), WsfScenario::GetAtmosphere(), and Tool::ProcessInput().

◆ SensitivityUpdate()

void ATG_LAR_And_LC_Generator::SensitivityUpdate ( double aSimTime )

protected

References WeaponObserver::cIN_FLIGHT, FireNewWeapon(), and Tool::mObserver.

Referenced by Update(), and ~ATG_LAR_And_LC_Generator().

◆ Update()

void ATG_LAR_And_LC_Generator::Update ( double aSimTime )

overridevirtual

Advance the Tool forward in time. This base method shall be overridden in derived classes, and at the end of the derived method, this parent method must be called, to properly maintain the internal state.

Reimplemented from Tool.

References LARGenUpdate(), SensitivityUpdate(), and Tool::Update().

◆ WriteOutputFile()

void ATG_LAR_And_LC_Generator::WriteOutputFile ( )

protected

References WsfATG_LaunchComputer::BaseTypeName(), WsfScenario::GetAtmosphere(), Tool::GetScenario(), and Tool::mOutputObjectName.

Referenced by ~ATG_LAR_And_LC_Generator().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ATG_LAR_And_LC_Generator() [1/2]

◆ ATG_LAR_And_LC_Generator() [2/2]

◆ ~ATG_LAR_And_LC_Generator()

Member Function Documentation

◆ Clone()

◆ ErrorBailout()

◆ FireNewWeapon()

◆ Initialize()

◆ LARGenUpdate()

◆ operator=()

◆ ProcessInput()

◆ SensitivityUpdate()

◆ Update()

◆ WriteOutputFile()