PlanetRelativeStatesModel.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.
******************************************************************************/
/*
Planet relative states model header file
 
Author: Gabriel Heredia Acevedo
*/
/* 
Metadata for MS GUI:
imdata = {"exclude" : True}
*/
 
#ifndef MODELS_STATES_PLANET_RELATIVE_STATES_MODEL_H
#define MODELS_STATES_PLANET_RELATIVE_STATES_MODEL_H
 
#include "simulation/Model.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    MODEL(PlanetRelativeStatesModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(equatorial_radius,       double,                 warpos::earth_wgs84.eq_radius)
            SIGNAL(flattening,              double,                 warpos::earth_wgs84.flattening)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
            //TODO: Inputs might not be needed
            SIGNAL(pos__pcr,                CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(vel__pcr,                CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
            SIGNAL(quat_obj_pcr,            clockwerk::Quaternion,  clockwerk::Quaternion({1.0, 0.0, 0.0, 0.0}))
            SIGNAL(angular_velocity_wrt_PCR,CartesianVector3,       CartesianVector3({0.0, 0.0, 0.0}))
        END_INPUTS
 
        // Model outputs
        //         NAME                            TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(latitude_detic,                 double,                 0.0)
            SIGNAL(latitude_centric,               double,                 0.0)
            SIGNAL(altitude_detic,                 double,                 0.0)
            SIGNAL(altitude_centric,               double,                 0.0)
            SIGNAL(longitude,                      double,                 0.0)
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override;  
 
        int _updateStates();

        double _radius;
        double _polar_radius;
    };
}
 
#endif