SimpleComAnalysisModel.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.
******************************************************************************/
 
/*
Communications Data Model header file
 
Author: Daniel Krobath
*/
/*
Metadata for MS GUI:
imdata = {"displayname" : "Simple Communication Analysis 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)",
           "range" : "Range (meters)",
           "masked" : "Masked (false = visible)",
           "free_space_path_loss" : "EXCLUDE",
           "eff_isotropic_radiated_pwr" : "EXCLUDE",
           "power_RX" : "EXCLUDE",
           "system_noise_figure" : "EXCLUDE",
           "signal_to_noise_ratio" : "Signal to Noise Ratio (dB)",
           "ebno_received" : "Eb/N0 Received (dB)",
           "link_margin" : "Link Margin (dB)",
}
*/
 
#ifndef MODELS_COMMUNICATIONS_SIMPLE_COM_ANALYSIS_MODEL_H
#define MODELS_COMMUNICATIONS_SIMPLE_COM_ANALYSIS_MODEL_H
 
#include <string>
#include <vector>
#include <cmath>
 
#include "simulation/Model.h"
 
namespace warptwin {

    MODEL(SimpleComAnalysisModel)
    public:
        // Model params
        //         NAME                             TYPE                        DEFAULT VALUE
        START_PARAMS
            SIGNAL(frequency,                       double,                     0.0)
            SIGNAL(bandwidth,                       double,                     0.0)
            SIGNAL(bit_rate,                        double,                     0.0)
            SIGNAL(power_TX,                        double,                     0.0)
            SIGNAL(return_loss,                     double,                     0.0)
            SIGNAL(gain_TX,                         double,                     0.0)
            SIGNAL(loss_TX,                         double,                     0.0)
            SIGNAL(gain_RX,                         double,                     0.0)
            SIGNAL(noise_temperature,               double,                     0.0)
            SIGNAL(loss_RX,                         double,                     0.0)
            SIGNAL(cross_pol_loss,                  double,                     0.0)
            SIGNAL(ebno_required,                   double,                     0.0)
        END_PARAMS
 
        // Model inputs
        //         NAME                             TYPE                        DEFAULT VALUE
        START_INPUTS
            SIGNAL(range,                           double,                     0.0)
            SIGNAL(masked,                          bool,                       true)
        END_INPUTS
 
        // Model outputs
        //         NAME                             TYPE                        DEFAULT VALUE
        START_OUTPUTS
            SIGNAL(free_space_path_loss,            double,                     0.0)
            SIGNAL(eff_isotropic_radiated_pwr,      double,                     0.0)
            SIGNAL(power_RX,                        double,                     0.0)
            SIGNAL(system_noise_figure,             double,                     0.0)
            SIGNAL(signal_to_noise_ratio,           double,                     0.0)
            SIGNAL(ebno_received,                   double,                     0.0)
            SIGNAL(link_margin,                     double,                     0.0)
        END_OUTPUTS

        double getGainRx(double antenna_diameter, double antenna_efficiency, double frequency) const;
 
    protected:
        int16 start() override;
        int16 execute() override;

        double _computeFreeSpacePathLoss(double range, double frequency) const;

        double _power_TX_dBm;

        double _power_reflected_W;
 
    };
}
 
#endif