WsfWeapon::FireResult Class Reference

Result of WsfWeapon::Fire(). More...

#include <WsfWeapon.hpp>

Collaboration diagram for WsfWeapon::FireResult:

Public Member Functions
	FireResult ()
	FireResult (bool aResult)
	operator bool () const

Public Attributes
bool	mSuccess
	'true' if WsfWeapon::Fire() is successful, 'false' otherwise.
WsfWeaponEngagement *	mEngagementPtr

Detailed Description

Result of WsfWeapon::Fire().

Constructor & Destructor Documentation

FireResult() [1/2]

WsfWeapon::FireResult::FireResult ( )

inline

References mEngagementPtr, and mSuccess.

FireResult() [2/2]

WsfWeapon::FireResult::FireResult ( bool aResult )

inline

References mEngagementPtr, and mSuccess.

Member Function Documentation

operator bool()

WsfWeapon::FireResult::operator bool ( ) const

inline

References mSuccess.

Member Data Documentation

mEngagementPtr

WsfWeaponEngagement* WsfWeapon::FireResult::mEngagementPtr

The pointer to the weapon engagement object that was created in response WsfWeapn::Fire(). This will be zero if the weapon was not fired (the return value from the method is 'false') OR if the underlying weapon does not support weapon engagement objects.

Referenced by wsf::UCI_WeaponComponent::CommandWeapon(), WsfImplicitWeapon::Fire(), WsfExplicitWeapon::FireP(), FireResult(), FireResult(), and WsfDisWeaponEvents::InitiateWeaponTransfer().

mSuccess

bool WsfWeapon::FireResult::mSuccess

'true' if WsfWeapon::Fire() is successful, 'false' otherwise.

Referenced by wsf::UCI_WeaponComponent::CommandWeapon(), WsfDirectedEnergyWeapon::Fire(), WsfImplicitWeapon::Fire(), WsfLaserWeapon::Fire(), WsfExplicitWeapon::FireP(), FireResult(), FireResult(), and operator bool().

---

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

• WsfWeapon.hpp