WsfWeapon::WsfWeaponMode Class Reference

A 'mode' of the weapon. More...

#include <WsfWeapon.hpp>

Inheritance diagram for WsfWeapon::WsfWeaponMode:

Collaboration diagram for WsfWeapon::WsfWeaponMode:

Public Member Functions
	WsfWeaponMode (const WsfScenario &aScenario)
	WsfWeaponMode (const WsfWeaponMode &aSrc)
	~WsfWeaponMode () override=default
WsfWeaponMode &	operator= (const WsfWeaponMode &)=delete
WsfPlatform *	GetPlatform () const
	Return the pointer to the platform to which the associated weapon is attached.
WsfWeapon *	GetWeapon () const
	Return the pointer to the weapon with which this mode is associated.
WsfMode *	Clone () const override=0
	Create an exact duplicate of this mode.
virtual bool	Initialize (double aSimTime, WsfWeapon *aWeaponPtr)
bool	ProcessInput (UtInput &aInput) override
void	Deselect (double aSimTime) override=0
void	Select (double aSimTime) override=0
const WsfScenario &	GetScenario () const
Public Member Functions inherited from WsfMode
	WsfMode ()
	~WsfMode () override=default
size_t	GetModeIndex () const
	Return the index of this mode within its associated mode list.
bool	IsSelected () const
	Returns 'true' if the mode is selected.
Public Member Functions inherited from WsfNamed
	WsfNamed ()
	WsfNamed (WsfStringId aName)
	WsfNamed (const WsfNamed &)=default
WsfNamed &	operator= (const WsfNamed &)=default
virtual	~WsfNamed ()=default
const std::string &	GetName () const
WsfStringId	GetNameId () const
void	SetName (WsfStringId aName)

Protected Attributes
const WsfScenario &	mScenario
WsfPlatform *	mPlatformPtr
	Pointer to the platform with which the weapon is associated.
WsfWeapon *	mWeaponPtr
	Pointer to the weapon with which the mode is associated.

Detailed Description

A 'mode' of the weapon.

Constructor & Destructor Documentation

WsfWeaponMode() [1/2]

WsfWeapon::WsfWeaponMode::WsfWeaponMode

(

const WsfScenario &

aScenario

)

References mPlatformPtr, mScenario, mWeaponPtr, and WsfMode::WsfMode().

Referenced by WsfRF_Jammer::JammerMode::JammerMode(), WsfRF_Jammer::JammerMode::JammerMode(), operator=(), and WsfWeaponMode().

WsfWeaponMode() [2/2]

WsfWeapon::WsfWeaponMode::WsfWeaponMode

(

const WsfWeaponMode &

aSrc

)

References mPlatformPtr, mScenario, mWeaponPtr, WsfMode::WsfMode(), and WsfWeaponMode().

~WsfWeaponMode()

WsfWeapon::WsfWeaponMode::~WsfWeaponMode ( )

overridedefault

Member Function Documentation

Clone()

WsfMode * WsfWeapon::WsfWeaponMode::Clone ( ) const

overridepure virtual

Create an exact duplicate of this mode.

Implements WsfMode.

Implemented in WsfRF_Jammer::JammerMode.

References WsfMode::WsfMode(), and WsfWeapon::WsfWeapon().

Deselect()

void WsfWeapon::WsfWeaponMode::Deselect ( double aSimTime )

overridepure virtual

Perform any actions necessary to de-select this mode.

Parameters

aSimTime

The current simulation time.

Note

This called ONLY by WsfModeList. Any other use is undefined.

Reimplemented from WsfMode.

Implemented in WsfRF_Jammer::JammerMode.

GetPlatform()

WsfPlatform * WsfWeapon::WsfWeaponMode::GetPlatform ( ) const

inline

Return the pointer to the platform to which the associated weapon is attached.

References mPlatformPtr.

GetScenario()

const WsfScenario & WsfWeapon::WsfWeaponMode::GetScenario ( ) const

inline

References mScenario.

GetWeapon()

WsfWeapon * WsfWeapon::WsfWeaponMode::GetWeapon ( ) const

inline

Return the pointer to the weapon with which this mode is associated.

References mWeaponPtr, and WsfWeapon::WsfWeapon().

Initialize()

bool WsfWeapon::WsfWeaponMode::Initialize ( double aSimTime, WsfWeapon * aWeaponPtr )

virtual

Reimplemented in WsfRF_Jammer::JammerMode.

References WsfPlatformPart::GetPlatform(), mPlatformPtr, mWeaponPtr, and WsfWeapon::WsfWeapon().

operator=()

WsfWeaponMode & WsfWeapon::WsfWeaponMode::operator= ( const WsfWeaponMode & )

delete

References WsfWeaponMode().

ProcessInput()

bool WsfWeapon::WsfWeaponMode::ProcessInput ( UtInput & aInput )

overridevirtual

Reimplemented from WsfMode.

References WsfMode::ProcessInput().

Select()

void WsfWeapon::WsfWeaponMode::Select ( double aSimTime )

overridepure virtual

Perform any actions necessary to select this mode.

Parameters

aSimTime

The current simulation time.

Note

This called ONLY by WsfModeList. Any other use is undefined.

Reimplemented from WsfMode.

Implemented in WsfRF_Jammer::JammerMode.

Member Data Documentation

mPlatformPtr

WsfPlatform* WsfWeapon::WsfWeaponMode::mPlatformPtr

protected

Pointer to the platform with which the weapon is associated.

Referenced by GetPlatform(), Initialize(), WsfWeaponMode(), and WsfWeaponMode().

mScenario

const WsfScenario& WsfWeapon::WsfWeaponMode::mScenario

protected

Referenced by GetScenario(), WsfWeaponMode(), and WsfWeaponMode().

mWeaponPtr

WsfWeapon* WsfWeapon::WsfWeaponMode::mWeaponPtr

protected

Pointer to the weapon with which the mode is associated.

Referenced by GetWeapon(), Initialize(), WsfWeaponMode(), and WsfWeaponMode().

---

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

• WsfWeapon.hpp
• WsfWeapon.cpp