WsfWeaponLAR Class Reference

An abstract class for specifying Weapon Launch Acceptable Regions (LARs). More...

#include <WsfWeaponLAR.hpp>

Inheritance diagram for WsfWeaponLAR:

Collaboration diagram for WsfWeaponLAR:

Public Member Functions
	WsfWeaponLAR ()
	~WsfWeaponLAR () override=default
WsfWeaponLAR *	Clone () const override=0
bool	DebugEnabled () const
	Returns 'true' if debugging is enabled for this instance.
void	SetDebugEnabled (bool aDebugEnabled)
bool	ProcessInput (UtInput &aInput) override
virtual bool	Initialize (WsfSimulation &aSimulation)
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 std::string	GetTypeString ()
static bool	LoadInstance (UtInput &aInput, WsfWeaponLAR *&aLARPtr)

Protected Member Functions
	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

An abstract class for specifying Weapon Launch Acceptable Regions (LARs).

The class must be extended further to provide whatever information is needed to launch a weapon against a target of interest. The information required will vary depending upon the type of weapon that is to be employed.

Constructor & Destructor Documentation

WsfWeaponLAR() [1/2]

WsfWeaponLAR::WsfWeaponLAR

(

)

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

Referenced by WsfATG_WeaponLAR::Clone(), Clone(), LoadInstance(), operator=(), WsfATG_WeaponLAR::WsfATG_WeaponLAR(), WsfATG_WeaponLAR::WsfATG_WeaponLAR(), and WsfWeaponLAR().

~WsfWeaponLAR()

WsfWeaponLAR::~WsfWeaponLAR ( )

overridedefault

WsfWeaponLAR() [2/2]

WsfWeaponLAR::WsfWeaponLAR ( const WsfWeaponLAR & aSrc )

protecteddefault

References WsfWeaponLAR().

Member Function Documentation

Clone()

WsfWeaponLAR * WsfWeaponLAR::Clone ( ) const

overridepure virtual

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

Implements WsfObject.

Implemented in WsfATG_WeaponLAR.

References WsfWeaponLAR().

DebugEnabled()

bool WsfWeaponLAR::DebugEnabled ( ) const

inline

Returns 'true' if debugging is enabled for this instance.

Referenced by WsfATG_WeaponLAR::IsInside().

GetSimulation()

WsfSimulation * WsfWeaponLAR::GetSimulation ( ) const

inline

Referenced by WsfATG_WeaponLAR::IsInside().

GetTypeString()

std::string WsfWeaponLAR::GetTypeString ( )

inlinestatic

Referenced by LoadInstance().

Initialize()

bool WsfWeaponLAR::Initialize ( WsfSimulation & aSimulation )

virtual

Reimplemented in WsfATG_WeaponLAR.

Referenced by WsfATG_WeaponLAR::Initialize().

LoadInstance()

bool WsfWeaponLAR::LoadInstance ( UtInput & aInput, WsfWeaponLAR *& aLARPtr )

static

References GetTypeString(), WsfATG_WeaponLAR::ProcessInputBlock(), success, and WsfWeaponLAR().

operator=()

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

protecteddelete

References WsfWeaponLAR().

ProcessInput()

bool WsfWeaponLAR::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 WsfObject::ProcessInput().

Referenced by WsfATG_WeaponLAR::ProcessInput().

SetDebugEnabled()

void WsfWeaponLAR::SetDebugEnabled ( bool aDebugEnabled )

inline

---

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

• WsfWeaponLAR.hpp
• WsfWeaponLAR.cpp