GroundStationModel.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.
******************************************************************************/
/*
Ground station model header file
 
Author: Alex Reynolds
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Ground Station",
          "exclude" : False,
          "category" : "Assemblies"
}
aliases = {"spacecraft_frame" : "Spacecraft Body",
           "planet_rotating_frame" : "Planet Rotating Frame",
           "R_planet" : "Planet Equatorial Radius",
           "flattening_planet" : "Ellipse Flattening",
           "latitude_detic_rad" : "Latitude",
           "longitude_rad" : "Longitude",
           "elevation_mask_rad" : "Elevation Mask",
           "position__enu" : "EXCLUDE",
           "velocity__enu" : "EXCLUDE",
           "range" : "Range",
           "range_rate" : "Range Rate",
           "azimuth" : "Azimuth",
           "elevation" : "Elevation",
           "masked" : "Masked",
           "gs_position__pci" : "EXCLUDE",
           "gs_velocity__pci" : "EXCLUDE",
           "self_ptr" : "Ground Station"
}
*/
 
#ifndef MODELS_STATES_GROUND_STATION_MODEL_H
#define MODELS_STATES_GROUND_STATION_MODEL_H
 
#include "FrameStateSensorModel.h"
#include "RangeAzElSensorModel.h"
#include "constants/planetdefaults.h"
 
namespace warptwin {

    MODEL(GroundStationModel)
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(spacecraft_frame,        Frame*,                nullptr)
            SIGNAL(planet_rotating_frame,   Frame*,                nullptr)
            SIGNAL(R_planet,                double,                 warpos::earth_wgs84.eq_radius)
            SIGNAL(flattening_planet,       double,                 warpos::earth_wgs84.flattening)
            SIGNAL(latitude_detic_rad,      double,                 0.0)
            SIGNAL(longitude_rad,           double,                 0.0)
            SIGNAL(elevation_mask_rad,      double,                 0.0)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(position__enu,           CartesianVector3,      CartesianVector3())
            SIGNAL(velocity__enu,           CartesianVector3,      CartesianVector3())
            SIGNAL(range,                   double,                 0.0)
            SIGNAL(range_rate,              double,                 0.0)
            SIGNAL(azimuth,                 double,                 0.0)
            SIGNAL(elevation,               double,                 0.0)
            SIGNAL(masked,                  bool,                   true)
            SIGNAL(gs_position__pci,        CartesianVector3,      CartesianVector3())
            SIGNAL(gs_velocity__pci,        CartesianVector3,      CartesianVector3())
            SIGNAL(self_ptr,                clockwerk::GraphTreeObject*,nullptr)
        END_OUTPUTS
 
        // Getters for handles to respective submodels
        // TODO: Fix this to not be needed because these can all be public. Until then it's here
        clockwerk::DataIO<Frame*> enuFrame = clockwerk::DataIO<Frame*>(this, "enuFrame", &_enu_frame);
        warptwin::FrameStateSensorModel* frameStateSensorEnu() {return &_fss_enu;}
        warptwin::RangeAzElSensorModel* rangeAzElSensor() {return &_range_az_el_sensor;}
    protected:
        int16 start() override;
        int16 execute() override; 

        Frame _enu_frame; 

        FrameStateSensorModel _fss_enu;

        RangeAzElSensorModel _range_az_el_sensor;

        FrameStateSensorModel _fss_gs_pci;
    };
 
}
 
#endif