WsfInstantAttitudeController Class Reference

An attitude controller that makes instantaneous changes in platform orientation. More...

#include <WsfInstantAttitudeController.hpp>

Inheritance diagram for WsfInstantAttitudeController:

Collaboration diagram for WsfInstantAttitudeController:

Public Member Functions
	WsfInstantAttitudeController ()
	WsfInstantAttitudeController (const WsfInstantAttitudeController &aOther)=default
	~WsfInstantAttitudeController () override=default
void	SetTargetOrientationECI (double aPsiECI, double aThetaECI, double aPhiECI) override
	Set the orientation target for this attitude controller.
void	GetTargetOrientationECI (double &aPsiECI, double &aThetaECI, double &aPhiECI) const override
	Get the current orientation target for this attitude controller.
void	UpdateOrientation (double aDeltaT) override
bool	AtTargetOrientation () const override
	Has the mover reached the target orientation.
WsfAttitudeController *	Clone () const override
	Clone this object.
Public Member Functions inherited from WsfAttitudeController
	WsfAttitudeController ()
	WsfAttitudeController (const WsfAttitudeController &aOther)
	~WsfAttitudeController () override=default
WsfAttitudeController &	operator= (const WsfAttitudeController &aSrc)=delete
void	SetTargetOrientation (double aYawECS, double aPitchECS, double aRollECS, const UtVec3d &aX_AxisOrientationECI, const UtVec3d &aZ_AxisConstraintECI)
virtual bool	CalculateOrientation (double &aPsi, double &aTheta, double &aPhi) const
	Calculate the updated orientation target.
void	Update (double aDeltaT)
	Update attitude controller.
bool	ProcessInput (UtInput &aInput) override
void	SetMover (WsfSpaceMoverBase *aMover)
	Set the mover to which this is attached.
WsfSpaceMoverBase *	GetMover () const
	Return the mover to which this attitude controller is attached.
void	SetOrientation (std::unique_ptr< wsf::space::Orientation > aOrientationPtr)
WSF_SPACE_DEPRECATED bool	SetOrientation (const std::string &aOrientation)
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)

Additional Inherited Members
Public Types inherited from WsfObject
typedef std::vector< WsfStringId >	TypeList
	The list of types returned by GetTypeList.
	WsfObject (const WsfObject &aSrc)
	Copy constructor (for Clone()).

Detailed Description

An attitude controller that makes instantaneous changes in platform orientation.

Constructor & Destructor Documentation

WsfInstantAttitudeController() [1/2]

WsfInstantAttitudeController::WsfInstantAttitudeController

(

)

References WsfAttitudeController::WsfAttitudeController().

Referenced by Clone(), and WsfInstantAttitudeController().

WsfInstantAttitudeController() [2/2]

WsfInstantAttitudeController::WsfInstantAttitudeController ( const WsfInstantAttitudeController & aOther )

default

References WsfInstantAttitudeController().

~WsfInstantAttitudeController()

WsfInstantAttitudeController::~WsfInstantAttitudeController ( )

overridedefault

Member Function Documentation

AtTargetOrientation()

bool WsfInstantAttitudeController::AtTargetOrientation ( ) const

overridevirtual

Has the mover reached the target orientation.

Implements WsfAttitudeController.

Clone()

WsfAttitudeController * WsfInstantAttitudeController::Clone ( ) const

inlineoverridevirtual

Clone this object.

Implements WsfAttitudeController.

References WsfAttitudeController::WsfAttitudeController(), and WsfInstantAttitudeController().

GetTargetOrientationECI()

void WsfInstantAttitudeController::GetTargetOrientationECI ( double & aPsiECI, double & aThetaECI, double & aPhiECI ) const

overridevirtual

Get the current orientation target for this attitude controller.

Implements WsfAttitudeController.

SetTargetOrientationECI()

void WsfInstantAttitudeController::SetTargetOrientationECI ( double aPsiECI, double aThetaECI, double aPhiECI )

overridevirtual

Set the orientation target for this attitude controller.

Implements WsfAttitudeController.

UpdateOrientation()

void WsfInstantAttitudeController::UpdateOrientation ( double aDeltaT )

overridevirtual

Perform update to orientation. This is responsible for updating the actual orientation of the platform

Implements WsfAttitudeController.

References WsfAttitudeController::GetMover(), and WsfPlatformPart::GetPlatform().

---

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

• WsfInstantAttitudeController.hpp
• WsfInstantAttitudeController.cpp