Module: dynamicEffector

Abstract class that is used to implement an effector impacting a dynamic body that does not itself maintain a state or represent a changing component of the body (for example: gravity, thrusters, SRP, etc.)

class DynamicEffector

#include <dynamicEffector.h>

dynamic effector class

Public Functions

DynamicEffector()

Constructor.

This is the constructor, just setting the variables to zero

virtual ~DynamicEffector()

Destructor.

This is the destructor, nothing to report here

virtual void computeStateContribution(double integTime): This method is an optional method by a dynamic effector and allows the dynamics effector to add direct contributions to a state effector derivative. Example - a thruster’s mDot will impact a fuel tanks total mDot

virtual void linkInStates(DynParamManager &states) = 0: Method to get access to other states/stateEffectors.

virtual void computeForceTorque(double integTime, double timeStep) = 0: — Method to computeForce and torque on the body

void setStateNameOfPosition(std::string value): setter for stateNameOfPosition property

inline const std::string getStateNameOfPosition() const: getter for stateNameOfPosition property

void setStateNameOfVelocity(std::string value): setter for stateNameOfVelocity property

inline const std::string getStateNameOfVelocity() const: getter for stateNameOfVelocity property

void setStateNameOfSigma(std::string value): setter for stateNameOfSigma property

inline const std::string getStateNameOfSigma() const: getter for stateNameOfSigma property

void setStateNameOfOmega(std::string value): setter for stateNameOfOmega property

inline const std::string getStateNameOfOmega() const: getter for stateNameOfOmega property

void setPropName_m_SC(std::string value): setter for propName_m_SC property

inline const std::string getPropName_m_SC() const: getter for propName_m_SC property

void setPropName_mDot_SC(std::string value): setter for propName_mDot_SC property

inline const std::string getPropName_mDot_SC() const: getter for propName_mDot_SC property

void setPropName_centerOfMassSC(std::string value): setter for propName_centerOfMassSC property

inline const std::string getPropName_centerOfMassSC() const: getter for propName_centerOfMassSC property

void setPropName_inertiaSC(std::string value): setter for propName_inertiaSC property

inline const std::string getPropName_inertiaSC() const: getter for propName_inertiaSC property

void setPropName_inertiaPrimeSC(std::string value): setter for propName_inertiaPrimeSC property

inline const std::string getPropName_inertiaPrimeSC() const: getter for propName_inertiaPrimeSC property

void setPropName_centerOfMassPrimeSC(std::string value): setter for propName_centerOfMassPrimeSC property

inline const std::string getPropName_centerOfMassPrimeSC() const: getter for propName_centerOfMassPrimeSC property

void setPropName_centerOfMassDotSC(std::string value): setter for propName_centerOfMassDotSC property

inline const std::string getPropName_centerOfMassDotSC() const: getter for propName_centerOfMassDotSC property

void setPropName_inertialPosition(std::string value): setter for propName_inertialPosition property

inline const std::string getPropName_inertialPosition() const: getter for propName_inertialPosition property

void setPropName_inertialVelocity(std::string value): setter for propName_inertialVelocity property

inline const std::string getPropName_inertialVelocity() const: getter for propName_inertialVelocity property

void setPropName_vehicleGravity(std::string value): setter for propName_vehicleGravity property

inline const std::string getPropName_vehicleGravity() const: getter for propName_vehicleGravity property

Public Members

Eigen::VectorXd stateDerivContribution: DynamicEffectors contribution to a stateEffector.

Eigen::Vector3d forceExternal_N = Eigen::Vector3d::Zero(): [N] External force applied by this effector in inertial components

Eigen::Vector3d forceExternal_B = Eigen::Vector3d::Zero(): [N] External force applied by this effector in body frame components

Eigen::Vector3d torqueExternalPntB_B = Eigen::Vector3d::Zero(): [Nm] External torque applied by this effector

BSKLogger bskLogger: BSK Logging.

Protected Attributes

std::string stateNameOfPosition = "": state engine name of the parent rigid body inertial position vector

std::string stateNameOfVelocity = "": state engine name of the parent rigid body inertial velocity vector

std::string stateNameOfSigma = "": state engine name of the parent rigid body inertial attitude

std::string stateNameOfOmega = "": state engine name of the parent rigid body inertial angular velocity vector

std::string propName_m_SC = "": property name of m_SC

std::string propName_mDot_SC = "": property name of mDot_SC

std::string propName_centerOfMassSC = "": property name of centerOfMassSC

std::string propName_inertiaSC = "": property name of inertiaSC

std::string propName_inertiaPrimeSC = "": property name of inertiaPrimeSC

std::string propName_centerOfMassPrimeSC = "": property name of centerOfMassPrimeSC

std::string propName_centerOfMassDotSC = "": property name of centerOfMassDotSC

std::string propName_inertialPosition = "": property name of inertialPosition

std::string propName_inertialVelocity = "": property name of inertialVelocity

std::string propName_vehicleGravity = "": property name of vehicleGravity