Detailed Description

Store information about a GNSS satellite's configuration.

Note: This class only implements the data storage and does not implement any I/O. The I/O is implemented in SatMetaDataStore, where polymorphism can be used to provide transparent access to other external storage mechanisms.; The signals value is expected to correlate to a named SatSignalsSet object.

Definition at line 56 of file SatMetaData.hpp.

#include <SatMetaData.hpp>

Public Types
enum	ClockType { ClockType::Unknown, ClockType::Crystal, ClockType::Cesium, ClockType::Rubidium, ClockType::Hydrogen, ClockType::USNO }
	Enumeration for the various types of frequency standards. More...

enum	Status { Status::Unknown, Status::Operational, Status::Decommissioned, Status::Test }
	Enumeration for the satellite usage states. More...

Public Member Functions
	SatMetaData ()
	Initialize data fields to reasonable defaults. More...

Static Public Member Functions
static ClockType	asClockType (const std::string &s)
	Convert string to ClockType. More...

static Status	asStatus (const std::string &s)
	Convert string to Status. More...

static std::string	asString (ClockType s)
	Convert ClockType to string. More...

static std::string	asString (Status s)
	Convert Status to string. More...

Public Attributes
uint8_t	activeClock
	Which of the above 4 clocks is active. More...

int32_t	chl
	Channel ID for FDMA satellites. More...

ClockType	clocks [NUMCLOCKS]
	Types of frequency standards available. More...

gnsstk::CommonTime	endTime
	When the satellite ceased operation. More...

gnsstk::CommonTime	launchTime
	When the satellite was launched. More...

std::string	mission
	Mission number. More...

int32_t	norad
	NORAD-assigned ID for this satellite. More...

std::string	plane
	Satellite plane identifier. More...

uint32_t	prn
	Pseudo-Random Number, identifies CDMA satellites. More...

std::string	signals
	Name of broadcast signal set. More...

std::string	slot
	Slot within the plane. More...

uint32_t	slotID
	Slot ID for FDMA satellites. More...

gnsstk::CommonTime	startTime
	When the satellite became operational. More...

Status	status
	Current satellite state. More...

std::string	svn
	Space vehicle number, a unique GNSS satellite ID. More...

SatelliteSystem	sys
	Which GNSS this satellite is from. More...

std::string	type
	Typically block number. More...

Static Public Attributes
static const unsigned	NUMCLOCKS = 4
	Maximum number of clocks on a satellite. More...

Member Enumeration Documentation

◆ ClockType

enum gnsstk::SatMetaData::ClockType

strong

Enumeration for the various types of frequency standards.

Enumerator
Unknown
Crystal
Cesium
Rubidium
Hydrogen
USNO

Definition at line 70 of file SatMetaData.hpp.

◆ Status

enum gnsstk::SatMetaData::Status

strong

Enumeration for the satellite usage states.

Enumerator
Unknown
Operational
Decommissioned
Test

Definition at line 62 of file SatMetaData.hpp.

Constructor & Destructor Documentation

◆ SatMetaData()

gnsstk::SatMetaData::SatMetaData ( )

Initialize data fields to reasonable defaults.

Definition at line 45 of file SatMetaData.cpp.

Member Function Documentation

◆ asClockType()

SatMetaData::ClockType gnsstk::SatMetaData::asClockType ( const std::string & s )

static

Convert string to ClockType.

Definition at line 125 of file SatMetaData.cpp.

◆ asStatus()

SatMetaData::Status gnsstk::SatMetaData::asStatus ( const std::string & s )

static

Convert string to Status.

Definition at line 89 of file SatMetaData.cpp.

◆ asString() [1/2]

std::string gnsstk::SatMetaData::asString ( SatMetaData::ClockType s )

static

Convert ClockType to string.

Definition at line 102 of file SatMetaData.cpp.

◆ asString() [2/2]

std::string gnsstk::SatMetaData::asString ( SatMetaData::Status s )

static

Convert Status to string.

Definition at line 70 of file SatMetaData.cpp.

Member Data Documentation

◆ activeClock

uint8_t gnsstk::SatMetaData::activeClock

Which of the above 4 clocks is active.

Definition at line 107 of file SatMetaData.hpp.

◆ chl

int32_t gnsstk::SatMetaData::chl

Channel ID for FDMA satellites.

Definition at line 94 of file SatMetaData.hpp.

◆ clocks

ClockType gnsstk::SatMetaData::clocks[NUMCLOCKS]

Types of frequency standards available.

Definition at line 106 of file SatMetaData.hpp.

◆ endTime

gnsstk::CommonTime gnsstk::SatMetaData::endTime

When the satellite ceased operation.

Definition at line 99 of file SatMetaData.hpp.

◆ launchTime

gnsstk::CommonTime gnsstk::SatMetaData::launchTime

When the satellite was launched.

Definition at line 97 of file SatMetaData.hpp.

◆ mission

std::string gnsstk::SatMetaData::mission

Mission number.

Definition at line 104 of file SatMetaData.hpp.

◆ norad

int32_t gnsstk::SatMetaData::norad

NORAD-assigned ID for this satellite.

Definition at line 93 of file SatMetaData.hpp.

◆ NUMCLOCKS

const unsigned gnsstk::SatMetaData::NUMCLOCKS = 4

static

Maximum number of clocks on a satellite.

Definition at line 60 of file SatMetaData.hpp.

◆ plane

std::string gnsstk::SatMetaData::plane

Satellite plane identifier.

Definition at line 100 of file SatMetaData.hpp.

◆ prn

uint32_t gnsstk::SatMetaData::prn

Pseudo-Random Number, identifies CDMA satellites.

Definition at line 91 of file SatMetaData.hpp.

◆ signals

std::string gnsstk::SatMetaData::signals

Name of broadcast signal set.

Definition at line 103 of file SatMetaData.hpp.

◆ slot

std::string gnsstk::SatMetaData::slot

Slot within the plane.

Definition at line 101 of file SatMetaData.hpp.

◆ slotID

uint32_t gnsstk::SatMetaData::slotID

Slot ID for FDMA satellites.

Definition at line 95 of file SatMetaData.hpp.

◆ startTime

gnsstk::CommonTime gnsstk::SatMetaData::startTime

When the satellite became operational.

Definition at line 98 of file SatMetaData.hpp.

◆ status

Status gnsstk::SatMetaData::status

Current satellite state.

Definition at line 105 of file SatMetaData.hpp.

◆ svn

std::string gnsstk::SatMetaData::svn

Space vehicle number, a unique GNSS satellite ID.

Definition at line 92 of file SatMetaData.hpp.

◆ sys

SatelliteSystem gnsstk::SatMetaData::sys

Which GNSS this satellite is from.

Definition at line 96 of file SatMetaData.hpp.

◆ type

std::string gnsstk::SatMetaData::type

Typically block number.

Definition at line 102 of file SatMetaData.hpp.

The documentation for this class was generated from the following files:

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Member Enumeration Documentation

◆ ClockType

◆ Status

Constructor & Destructor Documentation

◆ SatMetaData()

Member Function Documentation

◆ asClockType()

◆ asStatus()

◆ asString() [1/2]

◆ asString() [2/2]

Member Data Documentation

◆ activeClock

◆ chl

◆ clocks

◆ endTime

◆ launchTime

◆ mission

◆ norad

◆ NUMCLOCKS

◆ plane

◆ prn

◆ signals

◆ slot

◆ slotID

◆ startTime

◆ status

◆ svn

◆ sys

◆ type