#include <WsfRateLimitedAttitudeController.hpp>

Inheritance diagram for WsfRateLimitedAttitudeController:

[legend]

Collaboration diagram for WsfRateLimitedAttitudeController:

[legend]

Public Member Functions
	WsfRateLimitedAttitudeController ()
	WsfRateLimitedAttitudeController (const WsfRateLimitedAttitudeController &aOther)=default
	~WsfRateLimitedAttitudeController () override=default
void	SetTargetOrientationECI (double aPsi, double aTheta, double aPhi) override
	Set the orientation target for this attitude controller.
void	GetTargetOrientationECI (double &aPsi, double &aTheta, double &aPhi) 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.
bool	ProcessInput (UtInput &aInput) override
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.
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 than can only turn its platform at a specified rate. It is worth noting that this attitude controller will not necessarily find the optimal path between the current and target orientations.

Constructor & Destructor Documentation

◆ WsfRateLimitedAttitudeController() [1/2]

WsfRateLimitedAttitudeController::WsfRateLimitedAttitudeController ( )

References WsfAttitudeController::WsfAttitudeController().

Referenced by Clone(), and WsfRateLimitedAttitudeController().

◆ WsfRateLimitedAttitudeController() [2/2]

WsfRateLimitedAttitudeController::WsfRateLimitedAttitudeController ( const WsfRateLimitedAttitudeController & aOther )

default

References WsfRateLimitedAttitudeController().

◆ ~WsfRateLimitedAttitudeController()

WsfRateLimitedAttitudeController::~WsfRateLimitedAttitudeController ( )

overridedefault

Member Function Documentation

◆ AtTargetOrientation()

bool WsfRateLimitedAttitudeController::AtTargetOrientation ( ) const

overridevirtual

Has the mover reached the target orientation.

Implements WsfAttitudeController.

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

◆ Clone()

WsfAttitudeController * WsfRateLimitedAttitudeController::Clone ( ) const

inlineoverridevirtual

Clone this object.

Implements WsfAttitudeController.

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

◆ GetTargetOrientationECI()

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

overridevirtual

Get the current orientation target for this attitude controller.

Implements WsfAttitudeController.

◆ ProcessInput()

bool WsfRateLimitedAttitudeController::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 WsfAttitudeController.

References WsfAttitudeController::ProcessInput().