A class for specifying Weapon Launch Acceptable Regions (LARs) for Air-to-Ground weapons. More...

#include <WsfATG_WeaponLAR.hpp>

Inheritance diagram for WsfATG_WeaponLAR:

[legend]

Collaboration diagram for WsfATG_WeaponLAR:

[legend]

Public Member Functions
	WsfATG_WeaponLAR ()
	WsfATG_WeaponLAR (const WsfATG_WeaponLAR &aSrc)
	~WsfATG_WeaponLAR () override
WsfWeaponLAR *	Clone () const override
bool	ProcessInput (UtInput &aInput) override
bool	Initialize (WsfSimulation &aSimulation) override
void	ProcessInputBlock (UtInputBlock &aInputBlock)
double	LaunchSpeed () const
virtual bool	IsInside (const double aTargetPointWCS[3], const double aLaunchPointWCS[3], const double aLaunchHeading, const double aLaunchSpeed, const double aDeltaAltitude, const double aLaunchGamma) const
double	DeltaAltitude () const
	Delta Altitude is defined as Launcher Altitude minus Target Altitude.
const WsfZone *	GetZone () const
virtual bool	operator< (const WsfATG_WeaponLAR &aRhs) const
Public Member Functions inherited from WsfWeaponLAR
	WsfWeaponLAR ()
	~WsfWeaponLAR () override=default
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
bool	ProcessInput (UtInput &aInput) override
WsfSimulation *	GetSimulation () 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)

Static Public Member Functions
static WsfStringId	GetTypeId ()
Static Public Member Functions inherited from WsfWeaponLAR
static std::string	GetTypeString ()
static bool	LoadInstance (UtInput &aInput, WsfWeaponLAR *&aLARPtr)

Protected Member Functions
WsfATG_WeaponLAR &	operator= (const WsfATG_WeaponLAR &aRhs)
Protected Member Functions inherited from WsfWeaponLAR
	WsfWeaponLAR (const WsfWeaponLAR &aSrc)=default
WsfWeaponLAR &	operator= (const WsfWeaponLAR &aRhs)=delete
	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.

Detailed Description

A class for specifying Weapon Launch Acceptable Regions (LARs) for Air-to-Ground weapons.

Constructor & Destructor Documentation

◆ WsfATG_WeaponLAR() [1/2]

WsfATG_WeaponLAR::WsfATG_WeaponLAR ( )

References WsfObject::SetType(), and WsfWeaponLAR::WsfWeaponLAR().

Referenced by Clone(), operator<(), operator=(), and WsfATG_WeaponLAR().

◆ WsfATG_WeaponLAR() [2/2]

WsfATG_WeaponLAR::WsfATG_WeaponLAR ( const WsfATG_WeaponLAR & aSrc )

References WsfZone::Clone(), WsfObject::SetType(), WsfATG_WeaponLAR(), and WsfWeaponLAR::WsfWeaponLAR().

◆ ~WsfATG_WeaponLAR()

WsfATG_WeaponLAR::~WsfATG_WeaponLAR ( )

override

Member Function Documentation

◆ Clone()

WsfWeaponLAR * WsfATG_WeaponLAR::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 WsfWeaponLAR.

References WsfATG_WeaponLAR(), and WsfWeaponLAR::WsfWeaponLAR().

◆ DeltaAltitude()

double WsfATG_WeaponLAR::DeltaAltitude ( ) const

inline

Delta Altitude is defined as Launcher Altitude minus Target Altitude.

◆ GetTypeId()

WsfStringId WsfATG_WeaponLAR::GetTypeId ( )

static

◆ GetZone()

const WsfZone * WsfATG_WeaponLAR::GetZone ( ) const

inline

◆ Initialize()

bool WsfATG_WeaponLAR::Initialize ( WsfSimulation & aSimulation )

overridevirtual

Reimplemented from WsfWeaponLAR.

References WsfObject::GetName(), WsfSimulation::GetScenario(), and WsfWeaponLAR::Initialize().

◆ IsInside()

bool WsfATG_WeaponLAR::IsInside	(	const double	aTargetPointWCS[3],
		const double	aLaunchPointWCS[3],
		const double	aLaunchHeading,
		const double	aLaunchSpeed,
		const double	aDeltaAltitude,
		const double	aLaunchGamma ) const

virtual

References WsfWeaponLAR::DebugEnabled(), and WsfWeaponLAR::GetSimulation().

◆ LaunchSpeed()

double WsfATG_WeaponLAR::LaunchSpeed ( ) const

inline

◆ operator<()

virtual bool WsfATG_WeaponLAR::operator< ( const WsfATG_WeaponLAR & aRhs ) const

inlinevirtual

References WsfATG_WeaponLAR().

◆ operator=()

WsfATG_WeaponLAR & WsfATG_WeaponLAR::operator= ( const WsfATG_WeaponLAR & aRhs )

protected

References WsfATG_WeaponLAR().

◆ ProcessInput()

bool WsfATG_WeaponLAR::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::FindTypeT(), WsfScenario::FromInput(), and WsfWeaponLAR::ProcessInput().

Referenced by ProcessInputBlock().

◆ ProcessInputBlock()

void WsfATG_WeaponLAR::ProcessInputBlock ( UtInputBlock & aInputBlock )

References ProcessInput().

Referenced by WsfWeaponLAR::LoadInstance().

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WsfATG_WeaponLAR() [1/2]

◆ WsfATG_WeaponLAR() [2/2]

◆ ~WsfATG_WeaponLAR()

Member Function Documentation

◆ Clone()

◆ DeltaAltitude()

◆ GetTypeId()

◆ GetZone()

◆ Initialize()

◆ IsInside()

◆ LaunchSpeed()

◆ operator<()

◆ operator=()

◆ ProcessInput()

◆ ProcessInputBlock()