satellite-sgp4-mobility-model.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2016 INESC TEC
 * Copyright (c) 2021 CNES
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Code from https://gitlab.inesctec.pt/pmms/ns3-satellite
 *
 * Author: Pedro Silva  <pmms@inesctec.pt>
 * Author: Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef SAT_SGP4_MOBILITY_MODEL_H
#define SAT_SGP4_MOBILITY_MODEL_H
 
#include "julian-date.h"
#include "satellite-mobility-model.h"
#include "satellite-sgp4io.h"
#include "satellite-sgp4unit.h"
 
#include "ns3/nstime.h"
#include "ns3/vector.h"
 
#include <stdint.h>
#include <string>
 
namespace ns3
{

class SatSGP4MobilityModel : public SatMobilityModel
{
  public:
    static const gravconsttype WGeoSys;
    static const uint32_t TleSatInfoWidth;

    static TypeId GetTypeId(void);

    SatSGP4MobilityModel();

    virtual void NotifyConstructionCompleted() override;

    virtual ~SatSGP4MobilityModel();
 
    // Inherited from MobilityModel
    Ptr<MobilityModel> Copy() const override
    {
        return CreateObject<SatSGP4MobilityModel>(*this);
    }

    void SetStartDate(std::string startStr);

    JulianDate GetStartTime() const;

    void SetStartTime(const JulianDate& t);

    void SetTleInfo(const std::string& tle);
 
  private:
    struct Row
    {
        double r[3];
 
        double& operator[](uint32_t i)
        {
            return r[i];
        }
 
        const double& operator[](uint32_t i) const
        {
            return r[i];
        }
    };

    struct Matrix
    {
      public:
        Matrix(void)
        {
        }
 
        Matrix(double c00,
               double c01,
               double c02,
               double c10,
               double c11,
               double c12,
               double c20,
               double c21,
               double c22);
 
        Row& operator[](uint32_t i)
        {
            return m[i];
        }
 
        const Row& operator[](uint32_t i) const
        {
            return m[i];
        }
 
        Vector3D operator*(const Vector3D& v) const;
 
        Matrix Transpose(void) const;
 
      private:
        Row m[3];
    };
 
    std::string m_tle1, m_tle2;     
    mutable elsetrec m_sgp4_record; 
 
    virtual Vector DoGetVelocity() const;
 
    virtual GeoCoordinate DoGetGeoPosition() const;
    virtual void DoSetGeoPosition(const GeoCoordinate& position);
    virtual Vector DoGetPosition() const;
    virtual void DoSetPosition(const Vector& position);

    bool IsInitialized(void) const;

    JulianDate GetTleEpoch(void) const;

    static Vector3D rTemeTorItrf(const Vector3D& rteme, const JulianDate& t);

    static Matrix PefToItrf(const JulianDate& t);

    static Matrix TemeToPef(const JulianDate& t);

    static Vector3D rvTemeTovItrf(const Vector3D& rteme,
                                  const Vector3D& vteme,
                                  const JulianDate& t);

    mutable GeoCoordinate m_lastPosition;

    JulianDate m_start;

    std::string m_startStr;

    bool m_updatePositionEachRequest;

    Time m_updatePositionPeriod;

    mutable Time m_timeLastUpdate;
};
 
} // namespace ns3
 
#endif /* SAT_SGP4_MOBILITY_MODEL_H */