SatMetaData.hpp
Go to the documentation of this file.
1 //==============================================================================
2 //
3 // This file is part of GNSSTk, the ARL:UT GNSS Toolkit.
4 //
5 // The GNSSTk is free software; you can redistribute it and/or modify
6 // it under the terms of the GNU Lesser General Public License as published
7 // by the Free Software Foundation; either version 3.0 of the License, or
8 // any later version.
9 //
10 // The GNSSTk is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 // GNU Lesser General Public License for more details.
14 //
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with GNSSTk; if not, write to the Free Software Foundation,
17 // Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
18 //
19 // This software was developed by Applied Research Laboratories at the
20 // University of Texas at Austin.
21 // Copyright 2004-2022, The Board of Regents of The University of Texas System
22 //
23 //==============================================================================
24 
25 //==============================================================================
26 //
27 // This software was developed by Applied Research Laboratories at the
28 // University of Texas at Austin, under contract to an agency or agencies
29 // within the U.S. Department of Defense. The U.S. Government retains all
30 // rights to use, duplicate, distribute, disclose, or release this software.
31 //
32 // Pursuant to DoD Directive 523024
33 //
34 // DISTRIBUTION STATEMENT A: This software has been approved for public
35 // release, distribution is unlimited.
36 //
37 //==============================================================================
38 
39 #ifndef GNSSTK_SATMETADATA_HPP
40 #define GNSSTK_SATMETADATA_HPP
41 
42 #include <cstdint>
43 #include "SatID.hpp"
44 #include "CommonTime.hpp"
45 
46 namespace gnsstk
47 {
57  {
58  public:
60  static const unsigned NUMCLOCKS = 4;
62  enum class Status
63  {
64  Unknown,
67  Test
68  };
70  enum class ClockType
71  {
72  Unknown,
73  Crystal,
74  Cesium,
75  Rubidium,
76  Hydrogen,
77  USNO
78  };
80  SatMetaData();
81 
83  static std::string asString(Status s);
85  static Status asStatus(const std::string& s);
87  static std::string asString(ClockType s);
89  static ClockType asClockType(const std::string& s);
90 
91  uint32_t prn;
92  std::string svn;
93  int32_t norad;
94  int32_t chl;
95  uint32_t slotID;
100  std::string plane;
101  std::string slot;
102  std::string type;
103  std::string signals;
104  std::string mission;
107  uint8_t activeClock;
108  }; // class SatMetaData
109 
113  std::ostream& operator<<(std::ostream& s, const SatMetaData& smd);
114 
115  inline std::ostream& operator<<(std::ostream& s, SatMetaData::Status status)
116  {
117  s << SatMetaData::asString(status);
118  return s;
119  }
120 
121  inline std::ostream& operator<<(std::ostream& s, SatMetaData::ClockType ct)
122  {
123  s << SatMetaData::asString(ct);
124  return s;
125  }
126 
127 } // namespace gnsstk
128 
129 #endif // GNSSTK_SATMETADATA_HPP
gnsstk::SatMetaData::endTime
gnsstk::CommonTime endTime
When the satellite ceased operation.
Definition: SatMetaData.hpp:99
gnsstk::SatMetaData::ClockType::USNO
@ USNO
gnsstk::SatMetaData::ClockType::Rubidium
@ Rubidium
gnsstk::SatMetaData
Definition: SatMetaData.hpp:56
gnsstk::SatMetaData::slot
std::string slot
Slot within the plane.
Definition: SatMetaData.hpp:101
gnsstk::SatMetaData::type
std::string type
Typically block number.
Definition: SatMetaData.hpp:102
gnsstk::SatMetaData::plane
std::string plane
Satellite plane identifier.
Definition: SatMetaData.hpp:100
gnsstk::SatMetaData::sys
SatelliteSystem sys
Which GNSS this satellite is from.
Definition: SatMetaData.hpp:96
gnsstk::SatelliteSystem
SatelliteSystem
Supported satellite systems.
Definition: SatelliteSystem.hpp:55
gnsstk::SatMetaData::Status::Decommissioned
@ Decommissioned
SatID.hpp
gnsstk::SatMetaData::signals
std::string signals
Name of broadcast signal set.
Definition: SatMetaData.hpp:103
gnsstk::SatMetaData::ClockType::Hydrogen
@ Hydrogen
gnsstk::SatMetaData::norad
int32_t norad
NORAD-assigned ID for this satellite.
Definition: SatMetaData.hpp:93
gnsstk
For Sinex::InputHistory.
Definition: BasicFramework.cpp:50
gnsstk::SatMetaData::svn
std::string svn
Space vehicle number, a unique GNSS satellite ID.
Definition: SatMetaData.hpp:92
gnsstk::SatMetaData::status
Status status
Current satellite state.
Definition: SatMetaData.hpp:105
gnsstk::SatMetaData::prn
uint32_t prn
Pseudo-Random Number, identifies CDMA satellites.
Definition: SatMetaData.hpp:91
gnsstk::SatMetaData::ClockType
ClockType
Enumeration for the various types of frequency standards.
Definition: SatMetaData.hpp:70
gnsstk::SatMetaData::clocks
ClockType clocks[NUMCLOCKS]
Types of frequency standards available.
Definition: SatMetaData.hpp:106
gnsstk::SatMetaData::ClockType::Crystal
@ Crystal
gnsstk::operator<<
std::ostream & operator<<(std::ostream &s, const ObsEpoch &oe) noexcept
Definition: ObsEpochMap.cpp:54
gnsstk::CommonTime
Definition: CommonTime.hpp:84
gnsstk::SatMetaData::Status::Test
@ Test
gnsstk::SatMetaData::slotID
uint32_t slotID
Slot ID for FDMA satellites.
Definition: SatMetaData.hpp:95
gnsstk::SatMetaData::asClockType
static ClockType asClockType(const std::string &s)
Convert string to ClockType.
Definition: SatMetaData.cpp:125
gnsstk::SatMetaData::SatMetaData
SatMetaData()
Initialize data fields to reasonable defaults.
Definition: SatMetaData.cpp:45
gnsstk::SatMetaData::NUMCLOCKS
static const unsigned NUMCLOCKS
Maximum number of clocks on a satellite.
Definition: SatMetaData.hpp:60
gnsstk::SatMetaData::startTime
gnsstk::CommonTime startTime
When the satellite became operational.
Definition: SatMetaData.hpp:98
gnsstk::SatMetaData::Status
Status
Enumeration for the satellite usage states.
Definition: SatMetaData.hpp:62
gnsstk::SatMetaData::Status::Unknown
@ Unknown
gnsstk::SatMetaData::ClockType::Cesium
@ Cesium
gnsstk::SatMetaData::launchTime
gnsstk::CommonTime launchTime
When the satellite was launched.
Definition: SatMetaData.hpp:97
gnsstk::SatMetaData::chl
int32_t chl
Channel ID for FDMA satellites.
Definition: SatMetaData.hpp:94
CommonTime.hpp
gnsstk::SatMetaData::mission
std::string mission
Mission number.
Definition: SatMetaData.hpp:104
gnsstk::SatMetaData::Status::Operational
@ Operational
gnsstk::SatMetaData::ClockType::Unknown
@ Unknown
gnsstk::SatMetaData::asString
static std::string asString(Status s)
Convert Status to string.
Definition: SatMetaData.cpp:70
gnsstk::SatMetaData::asStatus
static Status asStatus(const std::string &s)
Convert string to Status.
Definition: SatMetaData.cpp:89
gnsstk::SatMetaData::activeClock
uint8_t activeClock
Which of the above 4 clocks is active.
Definition: SatMetaData.hpp:107


gnsstk
Author(s):
autogenerated on Wed Oct 25 2023 02:40:41