WSF
BallisticMissileLaunchComputerGenerator Class Reference

#include <BallisticMissileLaunchComputerGenerator.hpp>

Inheritance diagram for BallisticMissileLaunchComputerGenerator:
Collaboration diagram for BallisticMissileLaunchComputerGenerator:

Public Member Functions

 BallisticMissileLaunchComputerGenerator (WsfScenario &aScenario)
 BallisticMissileLaunchComputerGenerator (const BallisticMissileLaunchComputerGenerator &aSrc)
BallisticMissileLaunchComputerGeneratoroperator= (const BallisticMissileLaunchComputerGenerator &)=delete
 ~BallisticMissileLaunchComputerGenerator () override
ToolClone () const override
bool Initialize (WsfSimulation &aSimulation) override
bool ProcessInput (UtInput &aInput) override
void Update (double aSimTime) override
Public Member Functions inherited from Tool
 Tool (const Tool &aSrc)
Tooloperator= (const Tool &)=delete
 ~Tool () override
bool ProcessInput (UtInput &aInput) override
virtual void MoverBurnout (double aSimTime, WsfMover *aMoverPtr)
 name Callbacks from WeaponObserver (lets the tool have access to simulation callbacks)
virtual void GuidanceComputerPhaseChanged (double aSimTime, WsfGuidanceComputer *aComputerPtr)
 Optional tool method called by WeaponObserver to pass on the GuidanceComputerPhaseChanged simulation observer event.
virtual void PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr)
 Optional tool method called by WeaponObserver to pass on the PlatformAdded simulation observer event.
WsfStringId WeaponPlatformTypeId () const
double FrameStep () const
bool IsInitialized () const
WsfPlatformGetLauncherPlatform () const
WsfExplicitWeaponGetLauncherWeapon () 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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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)

Additional Inherited Members

Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
Protected Member Functions inherited from Tool
WsfSimulationGetSimulation () const
WsfScenarioGetScenario () const
ToolManagerGetManager () const
 Tool (WsfScenario &aScenario)
 This constructor initializes the object.
void UnInitialize ()
bool IsDone () const
 Return a flag to indicate that this Tool has completed its work.
bool DebugEnabled () const
 Return a flag to indicate that debugging is enabled.
virtual void ResolveNames ()
 Method called to determine what the output objects and file names are called.
virtual void ErrorBailout ()
 WsfObject (const WsfObject &aSrc)
 Copy constructor (for Clone()).
Protected Attributes inherited from Tool
WsfScenariomScenarioPtr
WsfSimulationmSimulationPtr
WeaponObserver mObserver
WsfPlatformmLaunchPlatPtr
WsfExplicitWeaponmLaunchWpnPtr
double mFrameStep
double mLastUpdate
double mLatDeg
double mLonDeg
double mAlt
double mHeadingRad
bool mDone
bool mNotifiedDone
bool mInitialized
bool mDebug
bool mTerminateOnLaunchFailure
std::string mToolProduces
std::string mFileExtension
WsfStringId mWeaponEffectTypeId
WsfStringId mLaunchPlatformTypeId
WsfStringId mTargetPlatformTypeId
WsfStringId mWeaponNameId
std::string mOutputFileName
std::string mOutputObjectName

Constructor & Destructor Documentation

◆ BallisticMissileLaunchComputerGenerator() [1/2]

BallisticMissileLaunchComputerGenerator::BallisticMissileLaunchComputerGenerator ( WsfScenario & aScenario)

◆ BallisticMissileLaunchComputerGenerator() [2/2]

BallisticMissileLaunchComputerGenerator::BallisticMissileLaunchComputerGenerator ( const BallisticMissileLaunchComputerGenerator & aSrc)

◆ ~BallisticMissileLaunchComputerGenerator()

BallisticMissileLaunchComputerGenerator::~BallisticMissileLaunchComputerGenerator ( )
override

Member Function Documentation

◆ Clone()

Tool * BallisticMissileLaunchComputerGenerator::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 Tool.

References BallisticMissileLaunchComputerGenerator(), and Tool::Tool().

◆ Initialize()

bool BallisticMissileLaunchComputerGenerator::Initialize ( WsfSimulation & aSimulation)
overridevirtual

In another typical WSF construct, this method initializes the object prior to run time. If the Initialization fails, the object will not be permitted to transition to the run mode. Derived classes must assure that they are initialized internally, as well as calling the base class Initialize method.

Returns
Boolean success value.

Reimplemented from Tool.

References computerPtr, WsfSimulation::GetSimTime(), Tool::Initialize(), Tool::mLaunchWpnPtr, Tool::mObserver, and ok.

◆ operator=()

BallisticMissileLaunchComputerGenerator & BallisticMissileLaunchComputerGenerator::operator= ( const BallisticMissileLaunchComputerGenerator & )
delete

◆ ProcessInput()

bool BallisticMissileLaunchComputerGenerator::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
aInputa 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 Tool::ProcessInput().

◆ Update()

void BallisticMissileLaunchComputerGenerator::Update ( double aSimTime)
overridevirtual

Advance the Tool forward in time. This base method shall be overridden in derived classes, and at the end of the derived method, this parent method must be called, to properly maintain the internal state.

Reimplemented from Tool.

References WeaponObserver::cIDLE, WeaponObserver::cIN_FLIGHT, WeaponObserver::cTERMINATED, Tool::DebugEnabled(), Tool::mDone, Tool::mObserver, Tool::Update(), and WsfPlatform::Update().


The documentation for this class was generated from the following files:
Copyrights Multiple, All Rights Reserved