wsf::space::OrientationGeoPoint Class Reference

#include <WsfSpaceOrientation.hpp>

Inheritance diagram for wsf::space::OrientationGeoPoint:

Collaboration diagram for wsf::space::OrientationGeoPoint:

Classes
class	GeoPointNotFoundException

Public Member Functions
	OrientationGeoPoint ()
	OrientationGeoPoint (const OrientationGeoPoint &aSrc)
bool	ProcessInput (UtInput &aInput) override
	Read the name of the GeoPoint to access on the platform.
bool	IsValid () const override
void	SetGeoPoint (const WsfGeoPoint &aGeoPoint)
void	SetGeoPointName (const std::string &aName)
const std::string &	GetGeoPointName () const
Public Member Functions inherited from wsf::space::Orientation
	Orientation (bool aIsDefaultX_Aligned)
	Orientation (const Orientation &aSrc)=default
	~Orientation () override=default
Orientation *	Clone () const override=0
const char *	GetScriptClassName () const override
void	SetAttitudeController (const WsfAttitudeController &aController)
	Set the automatic orientation to be used with the propagator.
virtual bool	Calculate (double &aPsi, double &aTheta, double &aPhi) const =0
void	CalculateAligned (const UtVec3d &aPointingAxisOrientationECI, const UtVec3d &aConstraintAxisOrientationECI, double &aPsi, double &aTheta, double &aPhi) const
void	SetDefaultX_Aligned (bool aIsDefaultX_Aligned)
bool	GetDefaultX_Aligned () 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)

Protected Member Functions
UtVec3d	TargetVector () const
Protected Member Functions inherited from wsf::space::Orientation
UtVec3d	Nadir () const
UtVec3d	Solar () const
UtVec3d	VelocityECI () const
UtVec3d	VelocityECEF () const
UtVec3d	OrbitPlaneConstraint (const UtVec3d &aAlignVector) const
void	HandleException (const UtException &aException) const
	Generic exception handler for exceptions encountered in derived classes.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Protected Attributes
std::string	mGeoPointName
std::unique_ptr< WsfGeoPoint >	mGeoPointPtr = nullptr
Protected Attributes inherited from wsf::space::Orientation
bool	mIssueErrorMessage {true}
bool	mDefaultX_Aligned
const WsfAttitudeController *	mControllerPtr {nullptr}

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
Static Public Member Functions inherited from wsf::space::Orientation
static std::unique_ptr< Orientation >	Factory (const std::string &aOrientation)
static void	CalculateGeneral (double aYawECS, double aPitchECS, double aRollECS, const UtVec3d &aX_AxisOrientationECI, const UtVec3d &aZ_AxisConstraintECI, double &aPsi, double &aTheta, double &aPhi)
static void	CalculateX_Aligned (const UtVec3d &aX_AxisOrientationECI, const UtVec3d &aZ_AxisConstraintECI, double &aPsi, double &aTheta, double &aPhi)
static void	CalculateZ_Aligned (const UtVec3d &aZ_AxisOrientationECI, const UtVec3d &aX_AxisConstraintECI, double &aPsi, double &aTheta, double &aPhi)
static void	CalculatePCS_DirectionCosines (const UtVec3d &aX_AxisOrientationECI, const UtVec3d &aZ_AxisConstraintECI, UtVec3d &aX_DC, UtVec3d &aY_DC, UtVec3d &aZ_DC)

Constructor & Destructor Documentation

OrientationGeoPoint() [1/2]

wsf::space::OrientationGeoPoint::OrientationGeoPoint

(

)

References wsf::space::Orientation::Orientation().

Referenced by OrientationGeoPoint(), and wsf::space::OrientationPointOrbitPlane::OrientationPointOrbitPlane().

OrientationGeoPoint() [2/2]

wsf::space::OrientationGeoPoint::OrientationGeoPoint

(

const OrientationGeoPoint &

aSrc

)

References mGeoPointName, mGeoPointPtr, wsf::space::Orientation::Orientation(), and OrientationGeoPoint().

Member Function Documentation

GetGeoPointName()

const std::string & wsf::space::OrientationGeoPoint::GetGeoPointName ( ) const

inline

References mGeoPointName.

IsValid()

bool wsf::space::OrientationGeoPoint::IsValid ( ) const

overridevirtual

Return whether the pointing and/or constraint lines-of-sight vectors are valid.

Note

This method returns false if an object being pointed at (e.g., another platform) does not or no longer exists.

Reimplemented from wsf::space::Orientation.

References wsf::space::Orientation::mControllerPtr, and mGeoPointName.

ProcessInput()

bool wsf::space::OrientationGeoPoint::ProcessInput ( UtInput & aInput )

overridevirtual

Read the name of the GeoPoint to access on the platform.

Reimplemented from wsf::space::Orientation.

References mGeoPointName.

SetGeoPoint()

void wsf::space::OrientationGeoPoint::SetGeoPoint

(

const WsfGeoPoint &

aGeoPoint

)

References WsfGeoPoint::Clone(), WsfNamed::GetName(), mGeoPointName, and mGeoPointPtr.

SetGeoPointName()

void wsf::space::OrientationGeoPoint::SetGeoPointName ( const std::string & aName )

inline

References mGeoPointName.

TargetVector()

UtVec3d wsf::space::OrientationGeoPoint::TargetVector ( ) const

protected

Returns

The unit vector from the platform to the GeoPoint.

References WsfGeoPoint::Clone(), wsf::space::Orientation::mControllerPtr, mGeoPointName, mGeoPointPtr, and platformPtr.

Member Data Documentation

mGeoPointName

std::string wsf::space::OrientationGeoPoint::mGeoPointName

protected

Referenced by GetGeoPointName(), IsValid(), OrientationGeoPoint(), ProcessInput(), SetGeoPoint(), SetGeoPointName(), and TargetVector().

mGeoPointPtr

std::unique_ptr<WsfGeoPoint> wsf::space::OrientationGeoPoint::mGeoPointPtr = nullptr

mutableprotected

Referenced by OrientationGeoPoint(), SetGeoPoint(), and TargetVector().

---

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

• WsfSpaceOrientation.hpp
• WsfSpaceOrientation.cpp