RadioModel.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.
******************************************************************************/
 
/*
Radio Model header file
 
Author: Alex Jackson
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Radio Model",
          "exclude" : False,
          "category" : "Assemblies"
}
aliases = {"frequency" : "Frequency (Hz)",
           "bandwidth" : "Bandwidth (Hz)",
           "bit_rate" : "Bit Rate (bps)",
           "power_TX" : "Transmit Power (W)",
           "gain_TX" : "Transmit Gain (dBi)",
           "loss_TX" : "Transmit Loss (dB)",
           "gain_RX" : "Receive Gain (dBi)",
           "loss_RX" : "Receive Loss (dB)",
           "noise_temperature" : "System Noise Temperature (K)",
           "cross_pol_loss" : "Cross Polarization Loss (dB)",
           "ebno_required" : "Eb/N0 Required (dB)",
           "power_draw_TX" : "Transmit Power Draw (W)",
           "power_draw_RX" : "Receive Power Draw (W)",
           "other_radio" : "Other Radio Model",
           "frame" : "Radio's Frame",
           "transmitting" : "Transmitting (1 = yes, 0 = no, -1 = auto)",
           "masked" : "Masked (false = visible)",
           "free_space_path_loss" : "EXCLUDE",
           "tx_eff_isotropic_radiated_pwr" : "EXCLUDE",
           "tx_power_RX" : "EXCLUDE",
           "tx_system_noise_figure" : "EXCLUDE",
           "tx_signal_to_noise_ratio" : "Signal to Noise Ratio (dB)",
           "tx_ebno_received" : "Eb/N0 Received (dB)",
           "tx_link_margin" : "Link Margin (dB)",
           "rx_eff_isotropic_radiated_pwr" : "EXCLUDE",
           "rx_power_RX" : "EXCLUDE",
           "rx_system_noise_figure" : "EXCLUDE",
           "rx_signal_to_noise_ratio" : "Signal to Noise Ratio (dB)",
           "rx_ebno_received" : "Eb/N0 Received (dB)",
           "rx_link_margin" : "Link Margin (dB)",
           "power_draw" : "Power Draw (W)",
}
*/
 
#ifndef MODELS_COMMUNICATIONS_RADIO_MODEL_H
#define MODELS_COMMUNICATIONS_RADIO_MODEL_H
 
#include "simulation/Model.h"
#include "SimpleComAnalysisModel.h"
#include "models/states/FrameStateSensorModel.h"
 
namespace warptwin {

    MODEL(RadioModel)
    public:
        // Model params
        //         NAME                             TYPE                        DEFAULT VALUE
        START_PARAMS
            SIGNAL(frequency,                       double,                     437e6)
            SIGNAL(bandwidth,                       double,                     50e3)
            SIGNAL(bit_rate,                        double,                     9600.0)
            SIGNAL(power_TX,                        double,                     1.0)
            SIGNAL(return_loss,                     double,                     14.0)
            SIGNAL(gain_TX,                         double,                     2.15)
            SIGNAL(loss_TX,                         double,                     5.0)
            SIGNAL(gain_RX,                         double,                     2.15)
            SIGNAL(noise_temperature,               double,                     307.5)
            SIGNAL(loss_RX,                         double,                     4.0)
            SIGNAL(cross_pol_loss,                  double,                     0.0)
            SIGNAL(ebno_required,                   double,                     11.0)
            SIGNAL(power_draw_TX,                   double,                     0.0)
            SIGNAL(power_draw_RX,                   double,                     0.0)
            SIGNAL(other_radio,                     GraphTreeObject*,           nullptr)
            SIGNAL(frame,                           Frame*,                     nullptr)
        END_PARAMS
 
        // Model inputs
        //         NAME                             TYPE                        DEFAULT VALUE
        START_INPUTS
            SIGNAL(masked,                          bool,                       true)
            SIGNAL(transmitting,                    int,                        -1)
        END_INPUTS
 
        // Model outputs
        //         NAME                             TYPE                        DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(free_space_path_loss,            double,                     0.0)
            SIGNAL(tx_eff_isotropic_radiated_pwr,      double,                     0.0)
            SIGNAL(tx_power_RX,                        double,                     0.0)
            SIGNAL(tx_system_noise_figure,             double,                     0.0)
            SIGNAL(tx_signal_to_noise_ratio,           double,                     0.0)
            SIGNAL(tx_ebno_received,                   double,                     0.0)
            SIGNAL(tx_link_margin,                     double,                     0.0)
            SIGNAL(rx_eff_isotropic_radiated_pwr,      double,                     0.0)
            SIGNAL(rx_power_RX,                        double,                     0.0)
            SIGNAL(rx_system_noise_figure,             double,                     0.0)
            SIGNAL(rx_signal_to_noise_ratio,           double,                     0.0)
            SIGNAL(rx_ebno_received,                   double,                     0.0)
            SIGNAL(rx_link_margin,                     double,                     0.0)
            SIGNAL(power_draw,                      double,                     0.0)
        END_OUTPUTS
 
    protected:
        int16 start() override;
        int16 execute() override;
 
        // The simple com analysis models that this model uses to compute comms data
        SimpleComAnalysisModel _tx_com_analysis_model; 
        SimpleComAnalysisModel _rx_com_analysis_model;
 
        // The frame state sensor used to get range data for the com analysis models
        FrameStateSensorModel _fss;
 
    };
}
 
#endif