SpicePlanet.h

Go to the documentation of this file.

/******************************************************************************
* Copyright (c) ATTX INC 2025. All Rights Reserved.
*
* This software and associated documentation (the "Software") are the 
* proprietary and confidential information of ATTX INC. 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 INC.
******************************************************************************/
/*
SPICE Planet header file
 
Author: Alex Reynolds
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "SPICE Planet",
          "exclude" : False,
          "category" : "Assemblies"
}
aliases = {"enable_attitude" : "EXCLUDE",
           "self_id" : "Self",
           "inertial_frame" : "Planet Inertial Frame",
           "rotating_frame" : "Planet Rotating Frame",
           "eq_radius" : "Equatorial Radius",
           "flattening" : "Ellipse Flattening",
           "mu" : "GM",
           "J2" : "J2",
           "J3" : "J3",
           "mean_ang_vel" : "Planet Ang. Vel.",
           "self_id" : "Planet"
}
*/
 
#ifndef MODELS_ASSEMBLIES_SPICE_PLANET_MODEL_H
#define MODELS_ASSEMBLIES_SPICE_PLANET_MODEL_H
 
#include "core/CartesianVector.hpp"
#include "simulation/Model.h"
#include "frames/Frame.h"
#include "simulation/SimScheduler.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    class SpicePlanet : public Model {
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(enable_attitude,         int,                    true) 
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(self_id,                 GraphTreeObject*,       nullptr)
            SIGNAL(inertial_frame,          Frame*,                nullptr)
            SIGNAL(rotating_frame,          Frame*,                nullptr)
            SIGNAL(eq_radius,               double,                 warpos::earth_wgs84.eq_radius)
            SIGNAL(flattening,              double,                 warpos::earth_wgs84.flattening)
            SIGNAL(mu,                      double,                 warpos::earth_wgs84.mu)
            SIGNAL(J2,                      double,                 warpos::earth_wgs84.J2)
            SIGNAL(J3,                      double,                 warpos::earth_wgs84.J3)
            SIGNAL(mean_ang_vel,            CartesianVector3,      CartesianVector3({0.0,0.0,warpos::earth_wgs84.mean_ang_vel}))
        END_OUTPUTS 
 
        // Model-specific implementations of startup and derivative
        SpicePlanet(SimulationExecutive &e, const std::string &m_name="earth");
        ~SpicePlanet();
 
    protected:
        int16 start() override;
        int16 execute() override;
 
        // The inertial frame of the planet
        Frame _planet_inertial = Frame("planet_inertial_frame");
 
        // The planet rotating frame
        Frame _planet_rotating = Frame("planet_rotating_frame");
 
        // Temporary state variables to hold calculations from spice
        clockwerk::DCM _tmp_dcm_p_pci;
        CartesianVector3 _tmp_vec;
        std::string _attitude_name;
    };
 
}
 
#endif