VisualsModel.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.
******************************************************************************/
/*
Visuals model header file
 
Author: Alex Reynolds
*/
 
#ifndef SIMULATION_VISUALS_MODEL_H
#define SIMULATION_VISUALS_MODEL_H
 
#include <string>
#include <map>
#include <set>
#include <fstream>
 
#include "simulation/SimulationSteps.h"
#include "frames/Frame.h"
#include "dynamics/Quaternion.h"
#include "locations.h"
#include "flight/App.h"
#include "core/mathmacros.h"
 
namespace warptwin {
 
    class RateMonitor;
    class SimulationExecutive;
    class GroundStationModel;
    class SpacecraftLinkModel;

    class VisualsModel : public warpos::App { 
    public:
        // Model params
        //         NAME                     TYPE                    DEFAULT VALUE
        START_PARAMS
            SIGNAL(sc_rate,                 clockwerk::Time,        clockwerk::Time(100, 0))
            SIGNAL(gs_rate,                 clockwerk::Time,        clockwerk::Time(1, 0))
            SIGNAL(lead_time,               clockwerk::Time,        clockwerk::Time(0, 0))
            SIGNAL(trail_time,              clockwerk::Time,        clockwerk::Time(5400, 0))
            SIGNAL(run_cesium_app,          int,                    1)
            SIGNAL(planet_ptr,              GraphTreeObject*,       nullptr)
            SIGNAL(real_time,               bool,                   false)
            SIGNAL(live_ip,                 std::string,            "127.0.0.1")
            SIGNAL(live_port,               int,                    40123)
        END_PARAMS
 
        // Model inputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_INPUTS
 
        END_INPUTS
 
        // Model outputs
        //         NAME                     TYPE                    DEFAULT VALUE
        START_OUTPUTS 
 
        END_OUTPUTS

        int addFrame(Frame* new_frame_ptr, const std::string& visual_model_dir = "");

        int addGroundStation(clockwerk::GraphTreeObject* new_gs_ptr);

        int addLink(clockwerk::GraphTreeObject* new_scl_pointer);
        
        // Model-specific implementations of startup and derivative
        VisualsModel(warpos::FlightExecutive &e, const std::string &m_name="visuals_model");
        virtual ~VisualsModel();
 
        void forceWrite() {_writeCzmlFile();}
    protected:
        int16 start() override;
        int16 execute() override;
 
        // Internal storage for planet inertial/rotating frames
        // Initialized to nullptr so _runAppProcess() (called before start() sets
        // these) safely skips the planet-name detection block.
        Frame* _planet_inertial_ptr = nullptr;
        Frame* _planet_fixed_ptr    = nullptr;

        void _runAppProcess();

        std::string _slurpFile(std::ifstream& in);

        void _generateCzmlString(std::string czml_template);

        void _writeCzmlFile();

        void _sendCzmlSocket();

        SimulationExecutive* _smex;

        std::ofstream _fout;

        int _sock_fd = 0;

        std::string _sim_start_time;
 
        // Set of vectors to log tracked spacecraft frames, spacecraft models, spacecraft times, and spacecraft states at those times
        std::vector<Frame*> _sc_frames;
        std::vector<std::string> _sc_frame_models;
        std::vector<double> _sc_times;
        std::vector<std::vector<CartesianVector3>> _sc_positions;
        std::vector<std::vector<clockwerk::Quaternion>> _sc_attitudes;
        CartesianVector3 _pos_f_planet_frame;
        RateMonitor* _sc_rate_monitor;                           // Controls the rate of SC logging
 
        // Set of vectors to log ground station states
        std::vector<GroundStationModel*> _gs_models;
        std::vector<std::vector<std::string>> _gs_sign_times_et; // Vector of times when GS visibility changed. Must include zero time
        std::vector<std::vector<bool>> _gs_sign_after_time;      // Vector of GS visibility signs after corresponding entry in _gs_sign_times_et
                                                    // with true = visible and false = not visible
        RateMonitor* _gs_rate_monitor;               // Controls the rate of GS logging
 
        // Set of vectors to log linkages between spacecraft
        std::vector<SpacecraftLinkModel*> _scl_models;
        std::vector<std::string> _link_names;
        std::vector<std::vector<std::string>> _scl_sign_times_et; // Vector of times when GS visibility changed. Must include zero time
        std::vector<std::vector<bool>> _scl_sign_after_time;      // Vector of GS visibility signs after corresponding entry in _gs_sign_times_et
                                                    // with true = visible and false = not visible
 
        // String information with templates and a location for generated json
        std::string _czml_file_template;                
        std::string _socket_template;                   
        std::string _sat_template;                      
        std::string _gs_template;
        std::string _fl_template;
        std::string _link_template;
        std::string _sc_link_template;
        std::string _generated_json;                    
    };
}
 
#endif