Public Member Functions |
Static Public Member Functions |
Protected Member Functions |
List of all members
wsf::space::OrientationSolarNadir Class Reference
#include <WsfSpaceOrientation.hpp>
Inheritance diagram for wsf::space::OrientationSolarNadir:
Collaboration diagram for wsf::space::OrientationSolarNadir:
Public Member Functions | |
| OrientationSolarNadir () | |
| Orientation * | Clone () const override |
| 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. | |
| bool | ProcessInput (UtInput &aInput) override |
| virtual bool | IsValid () const |
| 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) |
Static Public Member Functions | |
| static constexpr const char * | GetTypeName () |
| 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) |
Protected Member Functions | |
| bool | Calculate (double &aPsi, double &aTheta, double &aPhi) const override |
| 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()). | |
Additional Inherited Members | |
| Public Types inherited from WsfObject | |
| typedef std::vector< WsfStringId > | TypeList |
| The list of types returned by GetTypeList. | |
| Protected Attributes inherited from wsf::space::Orientation | |
| bool | mIssueErrorMessage {true} |
| bool | mDefaultX_Aligned |
| const WsfAttitudeController * | mControllerPtr {nullptr} |
Constructor & Destructor Documentation
◆ OrientationSolarNadir()
| wsf::space::OrientationSolarNadir::OrientationSolarNadir | ( | ) |
References GetTypeName(), wsf::space::Orientation::Orientation(), and WsfObject::SetType().
Referenced by Clone().
Member Function Documentation
◆ Calculate()
|
inlineoverrideprotectedvirtual |
Calculate the desired spacecraft orientation for the current location and velocity.
- Parameters
-
aPsi The calculated ECI 'heading' angle. aTheta The calculated ECI 'pitch' angle. aPhi The calculated ECI 'roll' angle.
Implements wsf::space::Orientation.
References wsf::space::Orientation::CalculateAligned(), wsf::space::Orientation::Nadir(), and wsf::space::Orientation::Solar().
◆ Clone()
|
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 wsf::space::Orientation::Orientation(), and OrientationSolarNadir().
◆ GetTypeName()
|
inlinestaticconstexpr |
Referenced by wsf::space::Orientation::Factory(), and OrientationSolarNadir().
The documentation for this class was generated from the following files: