WSF
wsf::space::OrientationPointOrbitPlane Class Reference

#include <WsfSpaceOrientation.hpp>

Inheritance diagram for wsf::space::OrientationPointOrbitPlane:
Collaboration diagram for wsf::space::OrientationPointOrbitPlane:

Public Member Functions

 OrientationPointOrbitPlane ()
 OrientationPointOrbitPlane (const OrientationPointOrbitPlane &aSrc)=default
OrientationClone () const override
Public Member Functions inherited from wsf::space::OrientationGeoPoint
 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
const char * GetScriptClassName () const override
void SetAttitudeController (const WsfAttitudeController &aController)
 Set the automatic orientation to be used with the propagator.
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 TypeListGetTypeList () const
bool IsA_TypeOf (WsfStringId aType) const
WsfObjectoperator= (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)

Static Public Member Functions

static constexpr const char * GetTypeName ()
Static Public Member Functions inherited from wsf::space::Orientation
static std::unique_ptr< OrientationFactory (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)

Additional Inherited Members

Public Types inherited from WsfObject
typedef std::vector< WsfStringIdTypeList
 The list of types returned by GetTypeList.
Protected Member Functions inherited from wsf::space::OrientationGeoPoint
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 inherited from wsf::space::OrientationGeoPoint
std::string mGeoPointName
std::unique_ptr< WsfGeoPointmGeoPointPtr = nullptr
Protected Attributes inherited from wsf::space::Orientation
bool mIssueErrorMessage {true}
bool mDefaultX_Aligned
const WsfAttitudeControllermControllerPtr {nullptr}

Constructor & Destructor Documentation

◆ OrientationPointOrbitPlane() [1/2]

wsf::space::OrientationPointOrbitPlane::OrientationPointOrbitPlane ( )

◆ OrientationPointOrbitPlane() [2/2]

wsf::space::OrientationPointOrbitPlane::OrientationPointOrbitPlane ( const OrientationPointOrbitPlane & aSrc)
default

Member Function Documentation

◆ Clone()

Orientation * wsf::space::OrientationPointOrbitPlane::Clone ( ) const
inlineoverridevirtual

Return a copy of this object. Must be implemented by all derived types. If cloning is impossible, a WsfUncloneableException should be thrown.

Implements wsf::space::Orientation.

References OrientationPointOrbitPlane().

◆ GetTypeName()

constexpr const char * wsf::space::OrientationPointOrbitPlane::GetTypeName ( )
inlinestaticconstexpr

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