WsfWeaponComponent Class Reference

#include <WsfWeaponComponent.hpp>

Inheritance diagram for WsfWeaponComponent:

Collaboration diagram for WsfWeaponComponent:

Utility methods.
WsfWeapon *	GetWeapon () const
WsfPlatform *	GetPlatform () const
WsfSimulation *	GetSimulation () const

Generic methods.
Actual processor model implementations do not need to worry about calling these directly because they are required to call base class methods that end up calling these methods. (e.g. WsfExplicitWeapon::ProcessInput calls WsfWeapon::ProcessInput). These always have the same argument lists as the routine from which they are called.
virtual void	TurnOn (double aSimTime)
virtual void	TurnOff (double aSimTime)
virtual bool	Initialize (double aSimTime)
virtual bool	Initialize2 (double aSimTime)
virtual bool	PreInitialize (double aSimTime)
virtual bool	ProcessInput (UtInput &aInput)

Additional Inherited Members
Public Types inherited from WsfComponentT< WsfWeapon >
typedef WsfWeapon	ParentType
	This is needed to support the WsfComponentList template.
Public Member Functions inherited from WsfComponentT< WsfWeapon >
	WsfComponentT ()
WsfComponentT &	operator= (const WsfComponentT &) noexcept
	~WsfComponentT () override=default
virtual void	ComponentParentChanged (ParentType *aParentPtr)
ParentType *	GetComponentParent () const
void	SetComponentParent (ParentType *aParentPtr)
Public Member Functions inherited from WsfComponent
virtual	~WsfComponent ()=default
virtual WsfComponent *	CloneComponent () const =0
virtual WsfStringId	GetComponentName () const =0
virtual const int *	GetComponentRoles () const =0
virtual void *	QueryInterface (int aRole)=0
virtual int	GetComponentInitializationOrder () const
template<typename T>
bool	QueryInterfaceT (T *&aRolePtr)
bool	ComponentHasRole (int aRole)
	Returns true if the component has the specified role.
virtual void	PreInput ()

Detailed Description

A abstract base class for processor extension components. Components can be added to implement additional functionality beyond what is provided by a specific model. The responsibilities of a derived class include: -) Implementing the 'required interface' methods as defined in WsfComponent. -) Implementing any desired 'common framework' methods defined in WsfComponent. -) Implementing any desired methods as defined below. -) Implementing the specific capabilities required by the derived class.

Member Function Documentation

GetPlatform()

WsfPlatform * WsfWeaponComponent::GetPlatform

(

)

const

References WsfComponentT< WsfWeapon >::GetComponentParent(), and WsfPlatformPart::GetPlatform().

Referenced by WsfChaffEjector::Initialize(), WsfChaffEjector::SetLaunchState(), and WsfChaffEjector::~WsfChaffEjector().

GetSimulation()

WsfSimulation * WsfWeaponComponent::GetSimulation

(

)

const

References WsfComponentT< WsfWeapon >::GetComponentParent(), and WsfPlatformPart::GetSimulation().

GetWeapon()

WsfWeapon * WsfWeaponComponent::GetWeapon ( ) const

inline

References WsfComponentT< PARENT_TYPE >::GetComponentParent().

Referenced by WsfChaffEjector::EjectParcel(), and WsfChaffEjector::Initialize().

Initialize()

bool WsfComponent::Initialize ( double aSimTime )

virtual

Perform phase 1 initialization. This is called by WsfPlatform::Initialize() during phase 1 initialization of the platform. The component should complete validation of input data that could not be done by ProcessInput, as well as any other functions to prepare for simulation use (subject to the next paragraph).

The order in which components are initialized is defined by GetComponentInitializationOrder. In general a component implementation of this method should not be dependent on the state of another component, i.e.: it should not assume that the other components Initialize() method has been called. If such a dependency exists one should use Initialize2() if possible, or specify a value GetComponentInitializationOrder to force things to initialize in a particular order.

Parameters

aSimTime

The current simulation time.

Returns

true if successful or false if unsuccessful (bad input data, etc.)

Note

This method should NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

Initialize2()

bool WsfComponent::Initialize2 ( double aSimTime )

virtual

Perform phase 2 initialization. This is called by WsfPlatform::Initialize() during phase 2 of platform initialization. This method is typically used when a component may have some dependency on another component having completed its phase 1 initialization. The component should be ready for use in the simulation upon completion of this method.

The order in which components are initialized is defined by GetComponentInitializationOrder.

Parameters

aSimTime

The current simulation time.

Returns

true if successful or false if unsuccessful.

Note

This method MUST NOT add any other components to the platform. This MUST be done in PreInitialize().

Reimplemented from WsfComponent.

PreInitialize()

bool WsfComponent::PreInitialize ( double aSimTime )

virtual

Perform pre-initializion function. This is called by WsfPlatform::Initialize prior to actually initializing the components on a platform (i.e.: calling Initialize and Initialize2 for each component). The primary reason for this method is to allow components to add other components that will then be subsequently initialized. The component may examine the component list and add components, but it must not assume ANYTHING about the actual state of the component.

Parameters

aSimTime

The current simulation time.

Returns

true if successful or false if unsuccessful (bad input data, etc.)

Reimplemented from WsfComponent.

ProcessInput()

bool WsfComponent::ProcessInput ( UtInput & aInput )

virtual

Evaluate the current input command and determine if it is one processed by the component. The component should get the current command from the input stream and determine if it is one that it recognizes. If it does not recognize the command then it should leave the command in the input stream and return false. If it does recognize the command then it should process the command and return true. If invalid arguments are encountered then it should throw an exception.

Parameters

aInput

The input stream.

Returns

true if the current command was recognized (and processed), or false if the command was not recognized.

Exceptions

UtInput::ExceptionBase

if an invalid input was encountered.

Reimplemented from WsfComponent.

TurnOff()

virtual void WsfWeaponComponent::TurnOff ( double aSimTime )

inlinevirtual

TurnOn()

virtual void WsfWeaponComponent::TurnOn ( double aSimTime )

inlinevirtual

---

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

• WsfWeaponComponent.hpp
• WsfWeaponComponent.cpp