SpacecraftLinkModel.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.
******************************************************************************/
/*
Spacecraft link model header file
 
Author: Alex Reynolds
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Spacecraft Link",
          "exclude" : False,
          "category" : "Assemblies"
}
aliases = {"sc_1_frame" : "Spacecraft 1 Body",
           "sc_2_frame" : "Spacecraft 2 Body",
           "r_planet" : "Planet Equatorial Radius",
           "planet_frame" : "Planet Frame",
           "max_range" : "Max Range (m)",
           "max_range_rate" : "Max Range Rate (m/s)",
           "max_az_look_angle" : "EXCLUDE",
           "max_el_look_angle" : "EXCLUDE",
           "range" : "Range",
           "range_rate" : "Range Rate",
           "visible" : "Visible",
           "sc_1_az_look_angle" : "EXCLUDE",
           "sc_1_el_look_angle" : "EXCLUDE",
}
*/
 
#ifndef MODELS_STATES_SPACECRAFT_LINK_MODEL_H
#define MODELS_STATES_SPACECRAFT_LINK_MODEL_H
 
#include "FrameStateSensorModel.h"
#include "RangeAzElSensorModel.h"
#include "models/environment/OccultationModel.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    MODEL(SpacecraftLinkModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(sc_1_frame,              Frame*,                 nullptr)
            SIGNAL(sc_2_frame,              Frame*,                 nullptr)
            SIGNAL(planet_frame,            Frame*,                 nullptr)
            SIGNAL(r_planet,                double,                 warpos::earth_wgs84.eq_radius)
            SIGNAL(max_range,               double,                 warpos::AU_TO_METERS)
            SIGNAL(max_range_rate,          double,                 warpos::AU_TO_METERS)
            SIGNAL(max_az_look_angle,        double,                 warpos::TWO_PI)
            SIGNAL(max_el_look_angle,        double,                 warpos::TWO_PI)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(range,                   double,                 0.0)
            SIGNAL(range_rate,              double,                 0.0)
            SIGNAL(sc_1_az_look_angle,      double,                 0.0)
            SIGNAL(sc_1_el_look_angle,      double,                 0.0)
            SIGNAL(visible,                 bool,                   false)
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override; 
 
        // The range, azimuth, elevation look angle for both spacecraft
        RangeAzElSensorModel _range_az_el_sensor;
 
        // Occultation model used internally
        OccultationModel _oc;
 
        // Temporary/local variables to hold intermediate calculations
        clockwerk::Quaternion _sc_quat_tmp_root;
        CartesianVector3 _sc_pos_tmp__root;
        CartesianVector3 _sc_vel_tmp__root;
        CartesianVector3 _sc_pos_tmp__sc;
        CartesianVector3 _sc_vel_tmp__sc;
    };
}
 
#endif