WSF
wsf::space::TimeOffsetTargetPoint Class Reference

#include <WsfTimeOffsetTargetPoint.hpp>

Inheritance diagram for wsf::space::TimeOffsetTargetPoint:
Collaboration diagram for wsf::space::TimeOffsetTargetPoint:

Public Member Functions

 TimeOffsetTargetPoint (std::unique_ptr< OrbitalTargetPoint > aTargetPoint, std::unique_ptr< UtOrbitalPropagatorBase > aPropagator, double aTimeOffset)
 ~TimeOffsetTargetPoint () override=default
TimeOffsetTargetPointClone () const override
 Create a copy of this target point.
void Update (const UtCalendar &aEpoch) override
 Update the point to the given aEpoch.
ut::OrbitalStateVector GetOrbitalStateVectorInertial () const override
 Return the combined inertial position and velocity of this point at this object's current epoch.
UtVec3d GetPositionECI () const override
 Return the ECI position of this point at this object's current epoch.
UtVec3d GetVelocityECI () const override
 Return the ECI velocity of this point at this object's current epoch.
UtCalendar GetEpoch () const override
 Return the current epoch of this point.
double GetCharacteristicTime () const override
double GetTimeOffset () const
void SetTimeOffset (double aTimeOffset)
Public Member Functions inherited from wsf::space::OrbitalTargetPoint
 OrbitalTargetPoint ()=default
virtual ~OrbitalTargetPoint ()=default

Detailed Description

A target point that predicts backward from a given target point.

This target point will predict backward (or forward) from another target point, called the base target, using a provided propagator. A space platform with a propagator like the one used during this objects construction, and that has achieved the kinematics of this target point, will reach the kinematics of the base target at a fixed time in the future.

Constructor & Destructor Documentation

◆ TimeOffsetTargetPoint()

wsf::space::TimeOffsetTargetPoint::TimeOffsetTargetPoint ( std::unique_ptr< OrbitalTargetPoint > aTargetPoint,
std::unique_ptr< UtOrbitalPropagatorBase > aPropagator,
double aTimeOffset )

Referenced by Clone().

◆ ~TimeOffsetTargetPoint()

wsf::space::TimeOffsetTargetPoint::~TimeOffsetTargetPoint ( )
overridedefault

Member Function Documentation

◆ Clone()

TimeOffsetTargetPoint * wsf::space::TimeOffsetTargetPoint::Clone ( ) const
inlineoverridevirtual

Create a copy of this target point.

Implements wsf::space::OrbitalTargetPoint.

References TimeOffsetTargetPoint().

◆ GetCharacteristicTime()

double wsf::space::TimeOffsetTargetPoint::GetCharacteristicTime ( ) const
overridevirtual

Return a characteristic time for this point.

This is used in the Target maneuver to set a maximum search time when there is no user input for this value. This method should return a reasonable time that likely includes the targeting solution. For example, a propagator based OrbitalTargetPoint might return the orbital period.

Returns
- A characteristic time (in seconds) for the motion of the underlying point.

Implements wsf::space::OrbitalTargetPoint.

◆ GetEpoch()

UtCalendar wsf::space::TimeOffsetTargetPoint::GetEpoch ( ) const
overridevirtual

Return the current epoch of this point.

Implements wsf::space::OrbitalTargetPoint.

◆ GetOrbitalStateVectorInertial()

ut::OrbitalStateVector wsf::space::TimeOffsetTargetPoint::GetOrbitalStateVectorInertial ( ) const
overridevirtual

Return the combined inertial position and velocity of this point at this object's current epoch.

Implements wsf::space::OrbitalTargetPoint.

Referenced by GetPositionECI(), and GetVelocityECI().

◆ GetPositionECI()

UtVec3d wsf::space::TimeOffsetTargetPoint::GetPositionECI ( ) const
overridevirtual

Return the ECI position of this point at this object's current epoch.

Implements wsf::space::OrbitalTargetPoint.

References GetOrbitalStateVectorInertial().

◆ GetTimeOffset()

double wsf::space::TimeOffsetTargetPoint::GetTimeOffset ( ) const
inline

◆ GetVelocityECI()

UtVec3d wsf::space::TimeOffsetTargetPoint::GetVelocityECI ( ) const
overridevirtual

Return the ECI velocity of this point at this object's current epoch.

Implements wsf::space::OrbitalTargetPoint.

References GetOrbitalStateVectorInertial().

◆ SetTimeOffset()

void wsf::space::TimeOffsetTargetPoint::SetTimeOffset ( double aTimeOffset)
inline

◆ Update()

void wsf::space::TimeOffsetTargetPoint::Update ( const UtCalendar & aEpoch)
overridevirtual

Update the point to the given aEpoch.

Implements wsf::space::OrbitalTargetPoint.


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