#include <AirToAirLaunchComputerGenerator.hpp>

Inheritance diagram for AirToAirLaunchComputerGenerator:

[legend]

Collaboration diagram for AirToAirLaunchComputerGenerator:

[legend]

Public Member Functions
	AirToAirLaunchComputerGenerator (WsfScenario &aScenario)
	~AirToAirLaunchComputerGenerator () override
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 Types
enum	StateType { cNO_STATE = 0 , cSTATE_INITIALIZED , cSTATE_GENERATION , cSTATE_DONE }
	Tool States, listed in chronological order: More...
enum	SearchingFor { cNO_SEARCH = 0 , cSEARCH_R_MIN , cSEARCH_R_NE , cSEARCH_R_MAX , cSEARCH_DONE }
enum	GenerationStateType { cNONE = 0 , cBRACKETING , cBISECTING , cDONE , cFAILED }

Protected Member Functions
void	ErrorBailout () override
void	Finish ()
bool	FireNewWeapon (double aSimTime) override
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-Air (ATA) Launch Computer Generation Tool (second variant). This Tool contains within it a pointer to a WsfAirToAirLaunchComputer object, which is configured with a sizable matrix of air-to-air engagement conditions. The Tool then traverses this matrix of engagement conditions, placing an airborne shooter and target at selected conditions. Engagement is repeated while range is iterated upon to yield three values, a minimum, maximum, and a range of no-escape, and weapon times-of-flight for each. A weapon is fired at the target immediately after it is placed, and given a perfect track to the target. The missile flies out, and if kinematically possible, the target is intercepted and killed. (USER CAUTION: For this Tool, a valid kinematic intercept of the target should ALWAYS result in a target kill, therefore the missile's intercept Pk should temporarily be set to 1.0, provided that the point of closest approach is within the lethal radius of the warhead.) If the engagement results in a target kill, the range and time of flight is saved into an array of results. If the target is not killed (at any range), a -1 is recorded. The process is repeated for each engagement condition. When all engagement results have been recorded, the results are written into an WSF-input format text file, defining the conditions appropriate to launch this weapon.

Member Enumeration Documentation

◆ GenerationStateType

enum AirToAirLaunchComputerGenerator::GenerationStateType

protected

Enumerator
cNONE
cBRACKETING
cBISECTING
cDONE
cFAILED

◆ SearchingFor

enum AirToAirLaunchComputerGenerator::SearchingFor

protected

Enumerator
cNO_SEARCH
cSEARCH_R_MIN
cSEARCH_R_NE
cSEARCH_R_MAX
cSEARCH_DONE

◆ StateType

enum AirToAirLaunchComputerGenerator::StateType

protected

Tool States, listed in chronological order:

Enumerator
cNO_STATE	Un-initialized.
cSTATE_INITIALIZED	Initialized.
cSTATE_GENERATION	Generating the results.
cSTATE_DONE	Complete.

Constructor & Destructor Documentation

◆ AirToAirLaunchComputerGenerator()

AirToAirLaunchComputerGenerator::AirToAirLaunchComputerGenerator ( WsfScenario & aScenario )

References WsfAirToAirLaunchComputer::BaseTypeName(), cNO_SEARCH, cNO_STATE, cNONE, Tool::mToolProduces, and Tool::Tool().

Referenced by Clone().

◆ ~AirToAirLaunchComputerGenerator()

AirToAirLaunchComputerGenerator::~AirToAirLaunchComputerGenerator ( )

override

Member Function Documentation

◆ Clone()

Tool * AirToAirLaunchComputerGenerator::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 AirToAirLaunchComputerGenerator(), and Tool::Tool().

◆ ErrorBailout()

void AirToAirLaunchComputerGenerator::ErrorBailout ( )

overrideprotectedvirtual

Reimplemented from Tool.

References Finish().

Referenced by FireNewWeapon().

◆ Finish()

void AirToAirLaunchComputerGenerator::Finish ( )

inlineprotected

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

Referenced by ErrorBailout().

◆ FireNewWeapon()

bool AirToAirLaunchComputerGenerator::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 cSEARCH_R_NE, Tool::DebugEnabled(), ErrorBailout(), WsfPlatform::GetIndex(), WsfPlatform::GetMover(), Tool::mAlt, Tool::mHeadingRad, Tool::mLatDeg, Tool::mLaunchPlatPtr, Tool::mLaunchWpnPtr, Tool::mLonDeg, Tool::mObserver, moverPtr, Tool::mTerminateOnLaunchFailure, and success.

◆ Initialize()

bool AirToAirLaunchComputerGenerator::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 cBRACKETING, cSTATE_INITIALIZED, Tool::DebugEnabled(), WsfSimulation::GetSimTime(), Tool::Initialize(), Tool::mInitialized, Tool::mLaunchWpnPtr, Tool::mObserver, Tool::mOutputFileName, and Tool::UnInitialize().

◆ ProcessInput()

bool AirToAirLaunchComputerGenerator::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 Tool::ProcessInput().

◆ Update()

void AirToAirLaunchComputerGenerator::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 WeaponObserver::cIN_FLIGHT, cSTATE_GENERATION, cSTATE_INITIALIZED, Tool::mLastUpdate, Tool::mObserver, and Tool::Update().

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

Public Member Functions

Protected Types

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GenerationStateType

◆ SearchingFor

◆ StateType

Constructor & Destructor Documentation

◆ AirToAirLaunchComputerGenerator()

◆ ~AirToAirLaunchComputerGenerator()

Member Function Documentation

◆ Clone()

◆ ErrorBailout()

◆ Finish()

◆ FireNewWeapon()

◆ Initialize()

◆ ProcessInput()

◆ Update()