WsfMover::KinematicModel Class Reference

#include <WsfMover.hpp>

Inheritance diagram for WsfMover::KinematicModel:

Public Member Functions
	KinematicModel ()=delete
	KinematicModel (const KinematicModel &aSrc)=default
virtual	~KinematicModel ()
double	GetApogeeTime () const
double	GetTimeAtLocation () const
double	GetStartTime () const
virtual bool	GetLocationXYZ (double aTime, double aLocXYZ[3]) const =0
virtual bool	GetVelocityXYZ (double aTime, double aVelXYZ[3]) const =0

Static Public Member Functions
static void	GetRangeAndAltitude (const double aOriginLocXYZ[3], const double aModelLocXYZ[3], double &aRange, double &aAltitude)

Protected Member Functions
	KinematicModel (double aSimTime, WsfStringId aModelTypeId)

Protected Attributes
double	mStartTime
double	mApogeeTime
double	mTimeAtLocation
WsfStringId	mModelTypeId

Detailed Description

A pure virtual base class encapsulating a kinematic model of a mover. It may be used to predict ahead the locations, times or apogee of entities.

Constructor & Destructor Documentation

KinematicModel() [1/3]

WsfMover::KinematicModel::KinematicModel ( )

delete

Referenced by WsfBallisticMissileLaunchComputer::BallisticModel::BallisticModel(), GetVelocityXYZ(), KinematicModel(), WsfSpaceMoverBase::SpaceModel::SpaceModel(), and WsfTSPI_Mover::TSPI_Model::TSPI_Model().

KinematicModel() [2/3]

WsfMover::KinematicModel::KinematicModel ( const KinematicModel & aSrc )

default

References KinematicModel().

~KinematicModel()

WsfMover::KinematicModel::~KinematicModel ( )

virtual

KinematicModel() [3/3]

WsfMover::KinematicModel::KinematicModel ( double aSimTime, WsfStringId aModelTypeId )

protected

References mApogeeTime, mModelTypeId, mStartTime, and mTimeAtLocation.

Member Function Documentation

GetApogeeTime()

double WsfMover::KinematicModel::GetApogeeTime ( ) const

inline

References mApogeeTime.

Referenced by WsfBallisticMissileLaunchComputer::ComputeAirIntercept().

GetLocationXYZ()

virtual bool WsfMover::KinematicModel::GetLocationXYZ ( double aTime, double aLocXYZ[3] ) const

pure virtual

Return the SPHERICAL WCS location of the model at the specified time.

Parameters

aTime	The time for which the model position is to be returned.
aLocXYZ	The spherical WCS location of the model at 'aSimTime'.

Returns

true if valid data was returned or false if no data exists for the specified time.

Implemented in WsfBallisticMissileLaunchComputer::BallisticModel, WsfSpaceMoverBase::SpaceModel, and WsfTSPI_Mover::TSPI_Model.

Referenced by WsfBallisticMissileLaunchComputer::ComputeAirIntercept(), WsfBallisticMissileLaunchComputer::ComputeLateralTargetOffset(), and WsfBallisticMissileLaunchComputer::ComputeLaunchWindows().

GetRangeAndAltitude()

void WsfMover::KinematicModel::GetRangeAndAltitude ( const double aOriginLocXYZ[3], const double aModelLocXYZ[3], double & aRange, double & aAltitude )

static

Referenced by WsfBallisticMissileLaunchComputer::ComputeLateralTargetOffset(), WsfBallisticMissileLaunchComputer::SA_Evaluator::FindLaunchWindowEnd(), WsfBallisticMissileLaunchComputer::SA_Evaluator::FindLaunchWindowStart(), and GetVelocityXYZ().

GetStartTime()

double WsfMover::KinematicModel::GetStartTime ( ) const

inline

References mStartTime.

Referenced by WsfBallisticMissileLaunchComputer::ComputeLateralTargetOffset().

GetTimeAtLocation()

double WsfMover::KinematicModel::GetTimeAtLocation ( ) const

inline

References mTimeAtLocation.

Referenced by WsfBallisticMissileLaunchComputer::ComputeAirIntercept().

GetVelocityXYZ()

virtual bool WsfMover::KinematicModel::GetVelocityXYZ ( double aTime, double aVelXYZ[3] ) const

pure virtual

Return the SPHERICAL WCS velocity of the model at the specified time.

Parameters

aTime	The time for which the model velocity is to be returned.
aVelXYZ	The spherical WCS velocity of the model at 'aSimTime'.

Returns

true if valid data was returned or false if no data exists for the specified time.

Note

This routine does not need to be particularly fast or accurate.

Implemented in WsfBallisticMissileLaunchComputer::BallisticModel, WsfSpaceMoverBase::SpaceModel, and WsfTSPI_Mover::TSPI_Model.

References GetRangeAndAltitude(), and KinematicModel().

Member Data Documentation

mApogeeTime

double WsfMover::KinematicModel::mApogeeTime

protected

Referenced by WsfBallisticMissileLaunchComputer::BallisticModel::BallisticModel(), GetApogeeTime(), KinematicModel(), WsfSpaceMoverBase::SpaceModel::SpaceModel(), and WsfTSPI_Mover::TSPI_Model::TSPI_Model().

mModelTypeId

WsfStringId WsfMover::KinematicModel::mModelTypeId

protected

Referenced by WsfBallisticMissileLaunchComputer::BallisticModel::BallisticModel(), and KinematicModel().

mStartTime

double WsfMover::KinematicModel::mStartTime

protected

Referenced by WsfBallisticMissileLaunchComputer::BallisticModel::BallisticModel(), WsfBallisticMissileLaunchComputer::BallisticModel::GetLocationXYZ(), WsfTSPI_Mover::TSPI_Model::GetLocationXYZ(), GetStartTime(), WsfBallisticMissileLaunchComputer::BallisticModel::GetVelocityXYZ(), WsfTSPI_Mover::TSPI_Model::GetVelocityXYZ(), KinematicModel(), and WsfTSPI_Mover::TSPI_Model::TSPI_Model().

mTimeAtLocation

double WsfMover::KinematicModel::mTimeAtLocation

protected

Referenced by WsfBallisticMissileLaunchComputer::BallisticModel::BallisticModel(), GetTimeAtLocation(), KinematicModel(), WsfSpaceMoverBase::SpaceModel::SpaceModel(), and WsfTSPI_Mover::TSPI_Model::TSPI_Model().

---

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

• WsfMover.hpp
• WsfMover.cpp