WsfGuidanceComputer::Phase Class Reference

A class that defines the guidance parameters for a phase of flight. More...

#include <WsfGuidanceComputer.hpp>

Public Types
enum	PN_Method { cPN_PHASE_DEFAULT , cPN_PURE , cPN_AUGMENTED }
using	ProgramAndPhase = std::pair<WsfStringId, WsfStringId>

Public Member Functions
	Phase ()
void	ExecuteOnEntry (double aSimTime, WsfScriptContext &aContext)
void	ExecuteOnExit (double aSimTime, WsfScriptContext &aContext)
void	ExecuteOnUpdate (double aSimTime, WsfScriptContext &aContext)
bool	Initialize (double aSimTime, WsfScriptContext &aContext)
bool	ProcessInput (UtInput &aInput, WsfGuidanceComputer &aComputer, WsfScriptContext &aContext)
void	ProcessNextPhase (UtInput &aInput, WsfScriptContext &aContext)

Public Attributes
UtScript *	mOnUpdateScriptPtr
WsfStringId	mPhaseName
double	mGuidanceDelay
double	mTimeConstant
double	mCommandedAlt
double	mCommandedAzimuthOffset
double	mCommandedFlightPathAngle
double	mCommandedSpeed
double	mCommandedThrottle
double	mAimpointAltitudeOffset
double	mAimpointAzimuthOffset
double	mAimpointRangeOffset
double	mAimpointEvaluationInterval
double	mCosLOS_Offset
double	mPN_GainValue
double	mVP_GainValue
double	mGeeBiasValue
double	mLateralGeeBiasValue
double	mMaxGeeCmd
double	mMaxPitchAngle
double	mMaxAscentRate
double	mMaxDescentRate
double	mPitchChangeGain
GuidanceTarget	mGuidanceTarget
OffsetDirection	mOffsetDirection
PN_Method	mPN_Method
bool	mCommandedAltIsAGL
bool	mAllowRouteFollowing
std::vector< WsfStringId >	mPrograms
WsfStringId	mEndOfRoutePhaseName
WsfStringId	mBoostCompletePhaseName
WsfStringId	mStageIgnitionPhaseName
WsfStringId	mStageBurnoutPhaseName
WsfStringId	mStageSeparationPhaseName
WsfStringId	mSensorTrackInitiatedPhaseName
std::vector< ProgramAndPhase >	mProgramCompletePhaseName
std::vector< PhaseChange >	mPhaseChangeList

Detailed Description

A class that defines the guidance parameters for a phase of flight.

Member Typedef Documentation

ProgramAndPhase

using WsfGuidanceComputer::Phase::ProgramAndPhase = std::pair<WsfStringId, WsfStringId>

Member Enumeration Documentation

PN_Method

enum WsfGuidanceComputer::Phase::PN_Method

Enumerator
cPN_PHASE_DEFAULT
cPN_PURE
cPN_AUGMENTED

Constructor & Destructor Documentation

Phase()

WsfGuidanceComputer::Phase::Phase

(

)

References WsfGuidanceComputer::cGT_DEFAULT, WsfGuidanceComputer::cOD_EITHER, cPN_PURE, WsfGuidanceComputer::cUNDEFINED_DOUBLE, mAimpointAltitudeOffset, mAimpointAzimuthOffset, mAimpointEvaluationInterval, mAimpointRangeOffset, mAllowRouteFollowing, mBoostCompletePhaseName, mCommandedAlt, mCommandedAltIsAGL, mCommandedAzimuthOffset, mCommandedFlightPathAngle, mCommandedSpeed, mCommandedThrottle, mCosLOS_Offset, mEndOfRoutePhaseName, mGeeBiasValue, mGuidanceDelay, mGuidanceTarget, mLateralGeeBiasValue, mMaxAscentRate, mMaxDescentRate, mMaxGeeCmd, mMaxPitchAngle, mOffsetDirection, mOnUpdateScriptPtr, mPhaseChangeList, mPhaseName, mPitchChangeGain, mPN_GainValue, mPN_Method, mProgramCompletePhaseName, mPrograms, mSensorTrackInitiatedPhaseName, mStageBurnoutPhaseName, mStageIgnitionPhaseName, mStageSeparationPhaseName, mTimeConstant, and mVP_GainValue.

Member Function Documentation

ExecuteOnEntry()

void WsfGuidanceComputer::Phase::ExecuteOnEntry	(	double	aSimTime,
		WsfScriptContext &	aContext )

References WsfScriptContext::ExecuteScript(), WsfScriptContext::FindScript(), and mPhaseName.

Referenced by wsf::six_dof::GuidanceComputer::SelectPhase(), and WsfGuidanceComputer::SelectPhase().

ExecuteOnExit()

void WsfGuidanceComputer::Phase::ExecuteOnExit	(	double	aSimTime,
		WsfScriptContext &	aContext )

References WsfScriptContext::ExecuteScript(), WsfScriptContext::FindScript(), and mPhaseName.

ExecuteOnUpdate()

void WsfGuidanceComputer::Phase::ExecuteOnUpdate	(	double	aSimTime,
		WsfScriptContext &	aContext )

References WsfScriptContext::ExecuteScript(), and mOnUpdateScriptPtr.

Referenced by wsf::six_dof::GuidanceComputer::SelectPhase(), and WsfGuidanceComputer::SelectPhase().

Initialize()

bool WsfGuidanceComputer::Phase::Initialize	(	double	aSimTime,
		WsfScriptContext &	aContext )

References WsfScriptContext::FindScript(), mAimpointAzimuthOffset, mAimpointRangeOffset, mOnUpdateScriptPtr, mPhaseName, and ok.

Referenced by WsfGuidanceComputer::Initialize().

ProcessInput()

bool WsfGuidanceComputer::Phase::ProcessInput	(	UtInput &	aInput,
		WsfGuidanceComputer &	aComputer,
		WsfScriptContext &	aContext )

References WsfGuidanceComputer::cFROM_LAUNCH_COMPUTER, WsfGuidanceComputer::cGT_DEFAULT, WsfGuidanceComputer::cGT_PERCEPTION, WsfGuidanceComputer::cGT_PREDICTED_INTERCEPT, WsfGuidanceComputer::cGT_TRUTH, WsfGuidanceComputer::cOD_EITHER, WsfGuidanceComputer::cOD_LEFT, WsfGuidanceComputer::cOD_RIGHT, WsfScriptContext::Compile(), cPN_AUGMENTED, cPN_PURE, WsfGuidanceProgramTypes::Get(), WsfPlatformPart::GetScenario(), mAimpointAltitudeOffset, mAimpointAzimuthOffset, mAimpointEvaluationInterval, mAimpointRangeOffset, mAllowRouteFollowing, mCommandedAlt, mCommandedAltIsAGL, mCommandedAzimuthOffset, mCommandedFlightPathAngle, mCommandedSpeed, mCommandedThrottle, mCosLOS_Offset, WsfGuidanceComputer::mDefinedPrograms, mGeeBiasValue, mGuidanceDelay, mGuidanceTarget, mLateralGeeBiasValue, mMaxAscentRate, mMaxDescentRate, mMaxGeeCmd, mMaxPitchAngle, mOffsetDirection, mPhaseName, mPitchChangeGain, mPN_GainValue, mPN_Method, mPrograms, mTimeConstant, mVP_GainValue, ProcessNextPhase(), and WsfGuidanceComputer::WsfGuidanceComputer().

Referenced by WsfGuidanceComputer::ProcessInput(), and WsfP6DOF_GuidanceComputer::ProcessInput().

ProcessNextPhase()

void WsfGuidanceComputer::Phase::ProcessNextPhase	(	UtInput &	aInput,
		WsfScriptContext &	aContext )

References WsfGuidanceComputer::PhaseChange::cALTITUDE, WsfGuidanceComputer::PhaseChange::cCLOSING_SPEED, WsfGuidanceComputer::PhaseChange::cDYNAMIC_PRESSURE, WsfGuidanceComputer::PhaseChange::cFLIGHT_PATH_ANGLE, WsfGuidanceComputer::PhaseChange::cFLIGHT_TIME, WsfGuidanceComputer::PhaseChange::cGREATER, WsfGuidanceComputer::PhaseChange::cGREATER_OR_EQUAL, WsfGuidanceComputer::PhaseChange::cLOS_TARGET_ANGLE, WsfGuidanceComputer::PhaseChange::cLOS_TARGET_AZIMUTH, WsfGuidanceComputer::PhaseChange::cLOS_TARGET_ELEVATION, WsfGuidanceComputer::PhaseChange::cON_COMMANDED_FLIGHT_PATH_ANGLE, WsfGuidanceComputer::PhaseChange::cPHASE_TIME, WsfGuidanceComputer::PhaseChange::cRANGE_TO_INTERCEPT, WsfGuidanceComputer::PhaseChange::cSPEED, WsfGuidanceComputer::PhaseChange::cTARGET_ALTITUDE, WsfGuidanceComputer::PhaseChange::cTARGET_AZIMUTH, WsfGuidanceComputer::PhaseChange::cTARGET_ELEVATION, WsfGuidanceComputer::PhaseChange::cTARGET_FLIGHT_PATH_ANGLE, WsfGuidanceComputer::PhaseChange::cTARGET_GROUND_RANGE, WsfGuidanceComputer::PhaseChange::cTARGET_SLANT_RANGE, WsfGuidanceComputer::PhaseChange::cTARGET_SPEED, WsfGuidanceComputer::PhaseChange::cTIME_TO_INTERCEPT, WsfGuidanceComputer::PhaseChange::cVERTICAL_SPEED, mBoostCompletePhaseName, WsfGuidanceComputer::PhaseChange::mCondition, mEndOfRoutePhaseName, WsfGuidanceComputer::PhaseChange::mName, mPhaseChangeList, mProgramCompletePhaseName, mSensorTrackInitiatedPhaseName, mStageBurnoutPhaseName, mStageIgnitionPhaseName, mStageSeparationPhaseName, WsfGuidanceComputer::PhaseChange::mValue, WsfGuidanceComputer::PhaseChange::ReadCondition(), WsfGuidanceComputer::Variable::ReadValueOfType(), WsfGuidanceComputer::Variable::ValueGreater(), WsfGuidanceComputer::Variable::ValueGreaterOrEqual(), and WsfGuidanceComputer::Variable::ValueLess().

Referenced by ProcessInput().

Member Data Documentation

mAimpointAltitudeOffset

double WsfGuidanceComputer::Phase::mAimpointAltitudeOffset

Referenced by Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), and WsfP6DOF_GuidanceComputer::UpdateAimpoint().

mAimpointAzimuthOffset

double WsfGuidanceComputer::Phase::mAimpointAzimuthOffset

Referenced by Initialize(), Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), and WsfP6DOF_GuidanceComputer::UpdateAimpoint().

mAimpointEvaluationInterval

double WsfGuidanceComputer::Phase::mAimpointEvaluationInterval

Referenced by Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), and WsfP6DOF_GuidanceComputer::UpdateAimpoint().

mAimpointRangeOffset

double WsfGuidanceComputer::Phase::mAimpointRangeOffset

Referenced by Initialize(), Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), and WsfP6DOF_GuidanceComputer::UpdateAimpoint().

mAllowRouteFollowing

bool WsfGuidanceComputer::Phase::mAllowRouteFollowing

Referenced by wsf::six_dof::GuidanceComputer::GetAllowRouteFollowing(), Phase(), ProcessInput(), WsfP6DOF_GuidanceComputer::SelectPhase(), wsf::six_dof::GuidanceComputer::UpdateRouteFollowing(), and WsfGuidanceComputer::UpdateRouteFollowing().

mBoostCompletePhaseName

WsfStringId WsfGuidanceComputer::Phase::mBoostCompletePhaseName

Referenced by WsfGuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mCommandedAlt

double WsfGuidanceComputer::Phase::mCommandedAlt

Referenced by WsfGuidanceProgram::AltitudeGuidance(), wsf::six_dof::GuidanceComputer::GetCommandedAltitude(), Phase(), ProcessInput(), WsfP6DOF_GuidanceComputer::SelectPhase(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), WsfP6DOF_GuidanceComputer::UpdateAimpoint(), wsf::six_dof::GuidanceComputer::UpdateTerrainFollowing(), and WsfGuidanceComputer::UpdateTerrainFollowing().

mCommandedAltIsAGL

bool WsfGuidanceComputer::Phase::mCommandedAltIsAGL

Referenced by WsfGuidanceProgram::AltitudeGuidance(), Phase(), ProcessInput(), WsfP6DOF_GuidanceComputer::SelectPhase(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), WsfP6DOF_GuidanceComputer::UpdateAimpoint(), wsf::six_dof::GuidanceComputer::UpdateTerrainFollowing(), and WsfGuidanceComputer::UpdateTerrainFollowing().

mCommandedAzimuthOffset

double WsfGuidanceComputer::Phase::mCommandedAzimuthOffset

Referenced by WsfGuidanceProgram::AngleOffsetGuidance(), Phase(), and ProcessInput().

mCommandedFlightPathAngle

double WsfGuidanceComputer::Phase::mCommandedFlightPathAngle

Referenced by Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::SelectPhase(), WsfGuidanceComputer::SelectPhase(), and WsfP6DOF_GuidanceComputer::SelectPhase().

mCommandedSpeed

double WsfGuidanceComputer::Phase::mCommandedSpeed

Referenced by wsf::six_dof::GuidanceComputer::GetCommandedSpeed(), Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::SelectPhase(), WsfGuidanceComputer::SelectPhase(), WsfP6DOF_GuidanceComputer::SelectPhase(), wsf::six_dof::GuidanceComputer::UpdateGuidance(), WsfGuidanceComputer::UpdateGuidance(), and WsfP6DOF_GuidanceComputer::UpdateGuidance().

mCommandedThrottle

double WsfGuidanceComputer::Phase::mCommandedThrottle

Referenced by Phase(), ProcessInput(), and WsfGuidanceComputer::UpdateGuidance().

mCosLOS_Offset

double WsfGuidanceComputer::Phase::mCosLOS_Offset

Referenced by Phase(), and ProcessInput().

mEndOfRoutePhaseName

WsfStringId WsfGuidanceComputer::Phase::mEndOfRoutePhaseName

Referenced by wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mGeeBiasValue

double WsfGuidanceComputer::Phase::mGeeBiasValue

Referenced by Phase(), and ProcessInput().

mGuidanceDelay

double WsfGuidanceComputer::Phase::mGuidanceDelay

Referenced by Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::SelectPhase(), WsfGuidanceComputer::SelectPhase(), and WsfP6DOF_GuidanceComputer::SelectPhase().

mGuidanceTarget

GuidanceTarget WsfGuidanceComputer::Phase::mGuidanceTarget

Referenced by Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), wsf::six_dof::GuidanceComputer::UpdateTargetPerception(), WsfGuidanceComputer::UpdateTargetPerception(), and WsfP6DOF_GuidanceComputer::UpdateTargetPerception().

mLateralGeeBiasValue

double WsfGuidanceComputer::Phase::mLateralGeeBiasValue

Referenced by Phase(), and ProcessInput().

mMaxAscentRate

double WsfGuidanceComputer::Phase::mMaxAscentRate

Referenced by WsfGuidanceProgram::AltitudeGuidance(), Phase(), and ProcessInput().

mMaxDescentRate

double WsfGuidanceComputer::Phase::mMaxDescentRate

Referenced by WsfGuidanceProgram::AltitudeGuidance(), Phase(), and ProcessInput().

mMaxGeeCmd

double WsfGuidanceComputer::Phase::mMaxGeeCmd

Referenced by WsfGuidanceProgram::AngleOffsetGuidance(), WsfGuidanceProgram::FlightPathAngleGuidance(), Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateGuidance(), WsfGuidanceComputer::UpdateGuidance(), and WsfP6DOF_GuidanceComputer::UpdateGuidance().

mMaxPitchAngle

double WsfGuidanceComputer::Phase::mMaxPitchAngle

Referenced by WsfGuidanceProgram::AltitudeGuidance(), Phase(), and ProcessInput().

mOffsetDirection

OffsetDirection WsfGuidanceComputer::Phase::mOffsetDirection

Referenced by Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateAimpoint(), WsfGuidanceComputer::UpdateAimpoint(), and WsfP6DOF_GuidanceComputer::UpdateAimpoint().

mOnUpdateScriptPtr

UtScript* WsfGuidanceComputer::Phase::mOnUpdateScriptPtr

Referenced by ExecuteOnUpdate(), Initialize(), and Phase().

mPhaseChangeList

std::vector<PhaseChange> WsfGuidanceComputer::Phase::mPhaseChangeList

Referenced by WsfGuidanceComputer::CheckForPhaseChange(), WsfP6DOF_GuidanceComputer::CheckForPhaseChange(), wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mPhaseName

WsfStringId WsfGuidanceComputer::Phase::mPhaseName

Referenced by ExecuteOnEntry(), ExecuteOnExit(), wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), ProcessInput(), WsfGuidanceComputer::ProcessInput(), WsfP6DOF_GuidanceComputer::ProcessInput(), wsf::six_dof::GuidanceComputer::UpdateGuidance(), WsfGuidanceComputer::UpdateGuidance(), and WsfGuidanceComputer::ValidateNextPhaseName().

mPitchChangeGain

double WsfGuidanceComputer::Phase::mPitchChangeGain

Referenced by Phase(), and ProcessInput().

mPN_GainValue

double WsfGuidanceComputer::Phase::mPN_GainValue

Referenced by Phase(), and ProcessInput().

mPN_Method

PN_Method WsfGuidanceComputer::Phase::mPN_Method

Referenced by Phase(), and ProcessInput().

mProgramCompletePhaseName

std::vector<ProgramAndPhase> WsfGuidanceComputer::Phase::mProgramCompletePhaseName

Referenced by WsfGuidanceComputer::CheckForPhaseChange(), WsfGuidanceComputer::Initialize(), Phase(), ProcessNextPhase(), wsf::six_dof::GuidanceComputer::SelectPhase(), WsfGuidanceComputer::SelectPhase(), wsf::six_dof::GuidanceComputer::UpdateGuidance(), and WsfGuidanceComputer::UpdateGuidance().

mPrograms

std::vector<WsfStringId> WsfGuidanceComputer::Phase::mPrograms

Referenced by wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), ProcessInput(), wsf::six_dof::GuidanceComputer::SelectPhase(), WsfGuidanceComputer::SelectPhase(), WsfP6DOF_GuidanceComputer::SelectPhase(), wsf::six_dof::GuidanceComputer::UpdateGuidance(), and WsfGuidanceComputer::UpdateGuidance().

mSensorTrackInitiatedPhaseName

WsfStringId WsfGuidanceComputer::Phase::mSensorTrackInitiatedPhaseName

Referenced by wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mStageBurnoutPhaseName

WsfStringId WsfGuidanceComputer::Phase::mStageBurnoutPhaseName

Referenced by wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mStageIgnitionPhaseName

WsfStringId WsfGuidanceComputer::Phase::mStageIgnitionPhaseName

Referenced by wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mStageSeparationPhaseName

WsfStringId WsfGuidanceComputer::Phase::mStageSeparationPhaseName

Referenced by wsf::six_dof::GuidanceComputer::Initialize(), WsfGuidanceComputer::Initialize(), WsfP6DOF_GuidanceComputer::Initialize(), Phase(), and ProcessNextPhase().

mTimeConstant

double WsfGuidanceComputer::Phase::mTimeConstant

Referenced by WsfGuidanceComputer::GetTimeConstant(), Phase(), and ProcessInput().

mVP_GainValue

double WsfGuidanceComputer::Phase::mVP_GainValue

Referenced by Phase(), and ProcessInput().

---

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

• WsfGuidanceComputer.hpp
• WsfGuidanceComputer.cpp