#include <OrbitalLaunchComputerGenerator.hpp>

Inheritance diagram for OrbitalLaunchComputerGenerator:

[legend]

Collaboration diagram for OrbitalLaunchComputerGenerator:

[legend]

Public Types
using	Orbit = WsfOrbitalLaunchComputer::Orbit
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.

Public Member Functions
	OrbitalLaunchComputerGenerator (WsfScenario &aScenario)
	OrbitalLaunchComputerGenerator (const OrbitalLaunchComputerGenerator &aSrc)
OrbitalLaunchComputerGenerator &	operator= (const OrbitalLaunchComputerGenerator &)=delete
	~OrbitalLaunchComputerGenerator () override=default
Public Member Functions inherited from Tool
	Tool (const Tool &aSrc)
Tool &	operator= (const Tool &)=delete
	~Tool () override
bool	ProcessInput (UtInput &aInput) override
WsfStringId	WeaponPlatformTypeId () const
double	FrameStep () const
bool	IsInitialized () const
WsfPlatform *	GetLauncherPlatform () const
WsfExplicitWeapon *	GetLauncherWeapon () 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)
Public Member Functions inherited from WsfSinglePlatformObserver
virtual	~WsfSinglePlatformObserver ()
virtual void	OnPlatformDeleting (double aSimTime, WsfPlatform *aPlatformPtr)
	Called before the platform is actually deleted.
virtual void	OnPlatformDeleted (double aSimTime, WsfPlatform *aPlatformPtr)
	Called just before the platform is removed from the simulation.
virtual void	OnPlatformUpdated (double aSimTime, WsfPlatform *aPlatformPtr)
	Called after each mover update.

Simulation observers
void	MoverBurnout (double aSimTime, WsfMover *aMoverPtr) override
	name Callbacks from WeaponObserver (lets the tool have access to simulation callbacks)
void	GuidanceComputerPhaseChanged (double aSimTime, WsfGuidanceComputer *aComputerPtr) override
	Optional tool method called by WeaponObserver to pass on the GuidanceComputerPhaseChanged simulation observer event.
void	PlatformAdded (double aSimTime, WsfPlatform *aPlatformPtr) override
	Optional tool method called by WeaponObserver to pass on the PlatformAdded simulation observer event.

weapon_tools 'Tool' methods.
Tool *	Clone () const override
bool	Initialize (WsfSimulation &aSimulation) override
bool	ProcessInput (UtInput &aInput) override
void	Update (double aSimTime) override

Additional Inherited Members
Protected Member Functions inherited from Tool
WsfSimulation *	GetSimulation () const
WsfScenario &	GetScenario () const
ToolManager *	GetManager () 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
WsfScenario *	mScenarioPtr
WsfSimulation *	mSimulationPtr
WeaponObserver	mObserver
WsfPlatform *	mLaunchPlatPtr
WsfExplicitWeapon *	mLaunchWpnPtr
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

Member Typedef Documentation

◆ Orbit

using OrbitalLaunchComputerGenerator::Orbit = WsfOrbitalLaunchComputer::Orbit

Constructor & Destructor Documentation

◆ OrbitalLaunchComputerGenerator() [1/2]

OrbitalLaunchComputerGenerator::OrbitalLaunchComputerGenerator ( WsfScenario & aScenario )

References Tool::mToolProduces, Tool::mWeaponEffectTypeId, and Tool::Tool().

Referenced by Clone(), operator=(), and OrbitalLaunchComputerGenerator().

◆ OrbitalLaunchComputerGenerator() [2/2]

OrbitalLaunchComputerGenerator::OrbitalLaunchComputerGenerator ( const OrbitalLaunchComputerGenerator & aSrc )

References Tool::mOutputFileName, Tool::mWeaponEffectTypeId, OrbitalLaunchComputerGenerator(), and Tool::Tool().

◆ ~OrbitalLaunchComputerGenerator()

OrbitalLaunchComputerGenerator::~OrbitalLaunchComputerGenerator ( )

overridedefault

References Tool::Tool().

Member Function Documentation

◆ Clone()

Tool * OrbitalLaunchComputerGenerator::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 OrbitalLaunchComputerGenerator(), and Tool::Tool().

◆ GuidanceComputerPhaseChanged()

void OrbitalLaunchComputerGenerator::GuidanceComputerPhaseChanged	(	double	aSimTime,
		WsfGuidanceComputer *	aComputerPtr )

overridevirtual

Optional tool method called by WeaponObserver to pass on the GuidanceComputerPhaseChanged simulation observer event.

Reimplemented from Tool.

References WsfGuidanceProgram::cGC_ORBIT_DECLARED, WsfPlatformPart::GetPlatform(), Tool::mObserver, and platformPtr.

◆ Initialize()

bool OrbitalLaunchComputerGenerator::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::mHeadingRad, Tool::mLaunchWpnPtr, Tool::mObserver, and ok.

◆ MoverBurnout()

void OrbitalLaunchComputerGenerator::MoverBurnout	(	double	aSimTime,
		WsfMover *	aMoverPtr )

overridevirtual

name Callbacks from WeaponObserver (lets the tool have access to simulation callbacks)

Optional tool method called by WeaponObserver to pass on the MoverBurnout simulation observer event.

Reimplemented from Tool.

References WsfPlatformPart::GetPlatform(), Tool::mObserver, and platformPtr.

◆ operator=()

OrbitalLaunchComputerGenerator & OrbitalLaunchComputerGenerator::operator= ( const OrbitalLaunchComputerGenerator & )

delete

References OrbitalLaunchComputerGenerator().

◆ PlatformAdded()

void OrbitalLaunchComputerGenerator::PlatformAdded	(	double	aSimTime,
		WsfPlatform *	aPlatformPtr )

overridevirtual

Optional tool method called by WeaponObserver to pass on the PlatformAdded simulation observer event.

Reimplemented from Tool.

References WsfObject::GetName(), WsfObject::GetType(), Tool::mLaunchPlatformTypeId, and Tool::mObserver.

◆ ProcessInput()

bool OrbitalLaunchComputerGenerator::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 Tool::mOutputFileName, and Tool::ProcessInput().

◆ Update()

void OrbitalLaunchComputerGenerator::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::mLaunchWpnPtr, Tool::mObserver, platformPtr, Tool::Update(), and WsfOrbitalLaunchComputer::WriteOrbits().

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

Public Types

Public Member Functions

Simulation observers

weapon_tools 'Tool' methods.

Additional Inherited Members

Member Typedef Documentation

◆ Orbit

Constructor & Destructor Documentation

◆ OrbitalLaunchComputerGenerator() [1/2]

◆ OrbitalLaunchComputerGenerator() [2/2]

◆ ~OrbitalLaunchComputerGenerator()

Member Function Documentation

◆ Clone()

◆ GuidanceComputerPhaseChanged()

◆ Initialize()

◆ MoverBurnout()

◆ operator=()

◆ PlatformAdded()

◆ ProcessInput()

◆ Update()