#include <WsfSpaceOrientation.hpp>

Inheritance diagram for wsf::space::OrientationEntity:

[legend]

Collaboration diagram for wsf::space::OrientationEntity:

[legend]

Classes
class	EntityNotFoundException
class	TrackNotFoundException
class	TrackLocationInvalidException

Public Member Functions
	OrientationEntity ()
bool	ProcessInput (UtInput &aInput) override
void	SetEntityName (const std::string &aEntityName)
const std::string &	GetEntityName () const
void	SetTrackId (const WsfTrackId &aTrackId)
const WsfTrackId &	GetLocalTrackId () const
bool	IsValid () const override
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	mEntityName
WsfTrackId	mTrackId
bool	mOrientToTrack = false
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

◆ OrientationEntity()

wsf::space::OrientationEntity::OrientationEntity ( )

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

Referenced by wsf::space::OrientationEntityNadir::OrientationEntityNadir(), wsf::space::OrientationEntityOrbitPlane::OrientationEntityOrbitPlane(), and wsf::space::OrientationEntitySolar::OrientationEntitySolar().

Member Function Documentation

◆ GetEntityName()

const std::string & wsf::space::OrientationEntity::GetEntityName ( ) const

inline

References mEntityName.

◆ GetLocalTrackId()

const WsfTrackId & wsf::space::OrientationEntity::GetLocalTrackId ( ) const

inline

References mTrackId.

◆ IsValid()

bool wsf::space::OrientationEntity::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.

◆ ProcessInput()

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

overridevirtual

Process input from a generic source.

Examine the current input command. If it is NOT one of the commands recognized by this class then it simply returns 'false'. If it is one of the commands recognized by this class then it processes the command and returns 'true'.

Parameters

aInput a reference to a UtInput object.

Returns: 'true' if the command was one recognized by the class or 'false' if not.

Exceptions

UtInput::ExceptionBase (or an object derived from it) if the command was recognized but contains some sort of error.

Note: If a derived class does not recognize the command (i.e.: the return value is false) then it should call the base class ProcessInput method. This chain should continue until either the command is recognized or the top-level base class is encountered.

Reimplemented from wsf::space::Orientation.

References mEntityName.