Gyro.h

/******************************************************************************
* Copyright (c) ATTX LLC 2024. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX, LLC. The Software is 
* furnished under a license agreement between ATTX and the user organization 
* and may be used or copied only in accordance with the terms of the agreement.
* Refer to 'license/attx_license.adoc' for standard license terms.
*
* EXPORT CONTROL NOTICE: THIS SOFTWARE MAY INCLUDE CONTENT CONTROLLED UNDER THE
* INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) OR THE EXPORT ADMINISTRATION 
* REGULATIONS (EAR99). No part of the Software may be used, reproduced, or 
* transmitted in any form or by any means, for any purpose, without the express 
* written permission of ATTX, LLC.
******************************************************************************/
/*
Gyro model header file
 
Author: Alex Reynolds
*/
 
#ifndef MODELS_SENSORS_GYRO_H
#define MODELS_SENSORS_GYRO_H
 
#include "core/macros.h"
#include "simulation/Model.h"
#include "six_dof_dynamics/Euler321.hpp"
#include "six_dof_dynamics/Quaternion.hpp"
#include "six_dof_dynamics/DCM.hpp"
#include "six_dof_dynamics/Frame.hpp"
#include "models/support/BiasNoiseModel.h"
#include "monitors/RateMonitor.h"
 
namespace modelspace {
 
    /**
     * @brief   Gyro Model
     * 
     * 
     * 
     * Author: Alex Reynolds <alex.reynolds@attx.tech>
    */
    class Gyro : public Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            /** The bias in measurement output described as a three-element vector in the same units
             *  as the output. Default is no bias. */
            SIGNAL(bias,                    CartesianVector3D,      CartesianVector3D({0.0, 0.0, 0.0}))
            /** The one-sigma gaussian noise in measurement output described as a three-element vector 
             *  in the same units as the output. Default is no noise. */
            SIGNAL(gaussian_noise,          CartesianVector3D,      CartesianVector3D({0.0, 0.0, 0.0}))
            /** The vehicle frame relative to which the sensor is mounted and aligned. This is most
             *  typically the body frame of a spacecraft or other vehicle. mount_position__mf and mount_alignment__mf
             *  are described relative to this frame. */
            SIGNAL(mount_frame,             FrameD*,                nullptr)
            /** The position of the sensor in the mount frame, represented in the default simulation
             *  unit (meters by default. pretty much always meters) */
            SIGNAL(mount_position__mf,      CartesianVector3D,      CartesianVector3D({0.0, 0.0, 0.0}))
            /** The alignment of the accelerometer relative to the mount frame */
            SIGNAL(mount_alignment_mf,      QuaternionD,            QuaternionD({1.0, 0.0, 0.0, 0.0}))
            /** The rate at which the sensor generates an output, in hertz. Setting this value
             *  to 0 forces the sensor to output at the simulation rate. */
            SIGNAL(rate_hz,                 int,                    0)
            /** Value to seed the internal RNG for this model. */
            SIGNAL(seed_value,              int,                    0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            /** The measured output angular velocity produced by the gyro describing the 
             *  angular velocity of the sensor frame relative to the simulation root frame
             *  appropriate bias, noise, and rate limiting */
            SIGNAL(meas_ang_vel_sf,         CartesianVector3D,         CartesianVector3D({0.0, 0.0, 0.0}))
            /** The "perfect" output angular velocity produced by the gyro describing the 
             *  angular velocity of the sensor frame (incl. misalignment) relative to the simulation root frame
             *  without bias and noise. This is an informational parameter. */
            SIGNAL(perfect_ang_vel_sf,      CartesianVector3D,         CartesianVector3D({0.0, 0.0, 0.0}))
        END_OUTPUTS
 
        /// @brief Accessor for the sensor's frame
        clockwerk::DataIO<FrameD*> sensor_frame = clockwerk::DataIO<FrameD*>(this, "sensor_frame", &_sensor_frame);
 
        /// @brief Accessor for the internal bias and noise model
        /// @return Pointer to the bias noise model
        modelspace::BiasNoiseModel* biasNoiseModel() {return &_sensor_bias_noise;}
 
        /// @brief Accessor for the internal rate monitor model
        /// @return Pointer to the rate monitor model
        modelspace::RateMonitor* rateMonitor() {return &_rate_monitor;}
 
        // Model-specific implementations of startup and derivative
        Gyro(Model &pnt, const std::string &m_name="gyro");
        Gyro(SimulationExecutive &e, const std::string &m_name="gyro");
        Gyro(Model &pnt, int schedule_slot, const std::string &m_name="gyro");
        Gyro(SimulationExecutive &e, int schedule_slot, const std::string &m_name="gyro");
        virtual ~Gyro() {}
    protected:
        int start();
        int execute();
 
        /// @brief Function to configure sensor -- runs in all constructors
        void _configureInternal();
 
        /// @brief The sensor frame in which all measurements will be taken
        FrameD _sensor_frame;
 
        /// @brief The bias and noise model for sensor output.
        BiasNoiseModel _sensor_bias_noise;
 
        /// @brief Rate monitor to control the rate at which the sensor runs
        RateMonitor _rate_monitor;
 
        /// @brief Temporary variable to hold total error for gyro
        CartesianVector3D _total_error;
    };
 
}
 
#endif