wsf::space::KinematicOffsetTargetPoint Class Reference

A target point that adapts another to provide an offset in a particular frame. More...

#include <WsfKinematicOffsetTargetPoint.hpp>

Inheritance diagram for wsf::space::KinematicOffsetTargetPoint:

Collaboration diagram for wsf::space::KinematicOffsetTargetPoint:

Public Member Functions
	KinematicOffsetTargetPoint (std::unique_ptr< OrbitalTargetPoint > aPointPtr)
	KinematicOffsetTargetPoint (const KinematicOffsetTargetPoint &aOther)
KinematicOffsetTargetPoint &	operator= (const KinematicOffsetTargetPoint &aOther)=delete
	~KinematicOffsetTargetPoint () override=default
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.
UtCalendar	GetEpoch () const override
	Return the current epoch of this point.
double	GetCharacteristicTime () const override
void	SetPositionOffset (const UtVec3d &aPositionOffset)
	Set the position offset in meters.
const UtVec3d &	GetPositionOffset () const
	Get the position offset in meters.
void	SetVelocityOffset (const UtVec3d &aVelocityOffset)
	Set the velocity offset in meters per second.
const UtVec3d &	GetVelocityOffset () const
	Get the velocity offset in meters per second.
const OrbitalTargetPoint &	GetParentPoint () const
	Get the point from to which the offset is added.
const OrbitalTargetPoint &	GetBasePoint () const
	Get the point from which the reference frame is computed.
Public Member Functions inherited from wsf::space::OrbitalTargetPoint
	OrbitalTargetPoint ()=default
virtual	~OrbitalTargetPoint ()=default
virtual OrbitalTargetPoint *	Clone () const =0
	Create a copy of this target point.
virtual UtVec3d	GetPositionECI () const =0
	Return the ECI position of this point at this object's current epoch.
virtual UtVec3d	GetVelocityECI () const =0
	Return the ECI velocity of this point at this object's current epoch.

Detailed Description

A target point that adapts another to provide an offset in a particular frame.

Constructor & Destructor Documentation

KinematicOffsetTargetPoint() [1/2]

wsf::space::KinematicOffsetTargetPoint::KinematicOffsetTargetPoint ( std::unique_ptr< OrbitalTargetPoint > aPointPtr )

explicit

Referenced by KinematicOffsetTargetPoint(), wsf::space::NTW_OffsetTargetPoint::NTW_OffsetTargetPoint(), operator=(), and wsf::space::RIC_OffsetTargetPoint::RIC_OffsetTargetPoint().

KinematicOffsetTargetPoint() [2/2]

wsf::space::KinematicOffsetTargetPoint::KinematicOffsetTargetPoint

(

const KinematicOffsetTargetPoint &

aOther

)

References KinematicOffsetTargetPoint().

~KinematicOffsetTargetPoint()

wsf::space::KinematicOffsetTargetPoint::~KinematicOffsetTargetPoint ( )

overridedefault

References GetCharacteristicTime(), GetEpoch(), and GetOrbitalStateVectorInertial().

Member Function Documentation

GetBasePoint()

const OrbitalTargetPoint & wsf::space::KinematicOffsetTargetPoint::GetBasePoint ( ) const

inline

Get the point from which the reference frame is computed.

References wsf::space::OrbitalTargetPoint::OrbitalTargetPoint().

Referenced by wsf::space::NTW_OffsetTargetPoint::GetPositionECI(), wsf::space::NTW_OffsetTargetPoint::GetVelocityECI(), and wsf::space::RIC_OffsetTargetPoint::Update().

GetCharacteristicTime()

double wsf::space::KinematicOffsetTargetPoint::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.

Referenced by ~KinematicOffsetTargetPoint().

GetEpoch()

UtCalendar wsf::space::KinematicOffsetTargetPoint::GetEpoch ( ) const

overridevirtual

Return the current epoch of this point.

Implements wsf::space::OrbitalTargetPoint.

Referenced by ~KinematicOffsetTargetPoint().

GetOrbitalStateVectorInertial()

ut::OrbitalStateVector wsf::space::KinematicOffsetTargetPoint::GetOrbitalStateVectorInertial ( ) const

overridevirtual

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

Implements wsf::space::OrbitalTargetPoint.

References wsf::space::OrbitalTargetPoint::GetPositionECI(), and wsf::space::OrbitalTargetPoint::GetVelocityECI().

Referenced by ~KinematicOffsetTargetPoint().

GetParentPoint()

const OrbitalTargetPoint & wsf::space::KinematicOffsetTargetPoint::GetParentPoint ( ) const

inline

Get the point from to which the offset is added.

References wsf::space::OrbitalTargetPoint::OrbitalTargetPoint().

Referenced by wsf::space::NTW_OffsetTargetPoint::GetPositionECI(), wsf::space::RIC_OffsetTargetPoint::GetPositionECI(), and wsf::space::NTW_OffsetTargetPoint::GetVelocityECI().

GetPositionOffset()

const UtVec3d & wsf::space::KinematicOffsetTargetPoint::GetPositionOffset ( ) const

inline

Get the position offset in meters.

Referenced by wsf::space::NTW_OffsetTargetPoint::GetPositionECI(), and wsf::space::RIC_OffsetTargetPoint::GetPositionECI().

GetVelocityOffset()

const UtVec3d & wsf::space::KinematicOffsetTargetPoint::GetVelocityOffset ( ) const

inline

Get the velocity offset in meters per second.

Referenced by wsf::space::NTW_OffsetTargetPoint::GetVelocityECI(), and wsf::space::RIC_OffsetTargetPoint::GetVelocityECI().

operator=()

KinematicOffsetTargetPoint & wsf::space::KinematicOffsetTargetPoint::operator= ( const KinematicOffsetTargetPoint & aOther )

delete

References KinematicOffsetTargetPoint().

SetPositionOffset()

void wsf::space::KinematicOffsetTargetPoint::SetPositionOffset ( const UtVec3d & aPositionOffset )

inline

Set the position offset in meters.

SetVelocityOffset()

void wsf::space::KinematicOffsetTargetPoint::SetVelocityOffset ( const UtVec3d & aVelocityOffset )

inline

Set the velocity offset in meters per second.

Update()

void wsf::space::KinematicOffsetTargetPoint::Update ( const UtCalendar & aEpoch )

overridevirtual

Update the point to the given aEpoch.

Implements wsf::space::OrbitalTargetPoint.

Reimplemented in wsf::space::RIC_OffsetTargetPoint.

Referenced by wsf::space::RIC_OffsetTargetPoint::Update().

---

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

• WsfKinematicOffsetTargetPoint.hpp
• WsfKinematicOffsetTargetPoint.cpp