Table of Contents

Class GlobalPositioningSystem

Namespace
NominalSystems.Classes
Assembly
NominalSystems.Classes.dll

[Nominal] The GPS (global positioning system) constellation system is able to provide positioning information about a particular constellation of GPS spacecraft that are initialised.

public class GlobalPositioningSystem : UniverseSystem
Inheritance
GlobalPositioningSystem

Constructors

GlobalPositioningSystem()

Default constructor

protected GlobalPositioningSystem()

Fields

FilePath

The file path for the GPS constellation data.

[ReadOnly]
public string FilePath

Field Value

string

Properties

ActiveSatellites

A list of active satellites based on a flag. This will be used to determine if the satellite is active or not. By disabling some satellites, the GPS position may become inaccurate.

public bool[] ActiveSatellites { get; }

Property Value

bool[]

IsInitialised

A flag whether the data has been loaded. This will ensure that on a new serialization, the data is reloaded.

[ReadOnly]
public bool IsInitialised { get; }

Property Value

bool

NumSatellites

The total number of satellites that are available in the network.

[Unit(UnitType.NONE)]
[ReadOnly]
public int NumSatellites { get; }

Property Value

int

Methods

Clear()

Clears the GPS system and removes all spacecraft points from the current list of positions.

public void Clear()

GetStates(Vector3)

Returns a list of GPS states that are available at a particular position and calculates the individual states of each of the GPS transmitters. This will be used by the GPS sensor to determine the location of the object in GPS coordinates.

public GPSState[] GetStates(Vector3 position)

Parameters

position Vector3

[m] The position of the sensor relative to the inertial origin

Returns

GPSState[]

An array of relevant GPS states

Initialise(string)

Loads the GPS constellation from a TLE lookup file, which will load in all the TLEs and create the transmitters associated with the GPS constellation.

public bool Initialise(string filePath)

Parameters

filePath string

The full file path to the TLE file

Returns

bool

A flag indicating whether the data was created correctly

OnLoad(double)

Called after all of the data has been loaded from a save state on this object. This enables any post-load operations to be performed and extra data to be loaded from the metadata.

protected override void OnLoad(double time)

Parameters

time double

[s] The current clock time of the simulation

OnSave()

Called before the object is saved into the save state. This ensures that any additional metadata can be saved on the object before it is automatically serialized.

protected override void OnSave()