org.orekit.propagation.analytical.gnss

Class GPSPropagator.Builder

java.lang.Object

org.orekit.propagation.analytical.gnss.GPSPropagator.Builder

Enclosing class:

GPSPropagator

public static class GPSPropagator.Builder
extends Object

This nested class aims at building a GPSPropagator.

It implements the classical builder pattern.

Constructor Summary

Constructors

Constructor and Description
Builder(GPSOrbitalElements gpsOrbElt) Initializes the builder.
Builder(GPSOrbitalElements gpsOrbElt, Frames frames) Initializes the builder.

Method Summary

Modifier and Type	Method and Description
GPSPropagator.Builder	attitudeProvider(AttitudeProvider userProvider) Sets the attitude provider.
GPSPropagator	build() Finalizes the build.
GPSPropagator.Builder	ecef(Frame bodyFixed) Sets the Earth Centered Earth Fixed frame assimilated to the WGS84 ECEF.
GPSPropagator.Builder	eci(Frame inertial) Sets the Earth Centered Inertial frame used for propagation.
GPSPropagator.Builder	mass(double userMass) Sets the mass.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

@DefaultDataContext
public Builder(GPSOrbitalElements gpsOrbElt)

Initializes the builder.

The GPS orbital elements is the only requested parameter to build a GPSPropagator.

The attitude provider is set by default to the DEFAULT_LAW in the default data context.
The mass is set by default to the DEFAULT_MASS.
The ECI frame is set by default to the EME2000 frame in the default data context.
The ECEF frame is set by default to the CIO/2010-based ITRF simple EOP in the default data context.

This constructor uses the default data context. Another data context can be set using Builder(final GPSOrbitalElements gpsOrbElt, final Frames frames)

Parameters:

gpsOrbElt - the GPS orbital elements to be used by the GPSpropagator.

See Also:

attitudeProvider(AttitudeProvider provider), mass(double mass), eci(Frame inertial), ecef(Frame bodyFixed)

Builder

public Builder(GPSOrbitalElements gpsOrbElt,
               Frames frames)

Initializes the builder.

The GPS orbital elements is the only requested parameter to build a GPSPropagator.

The attitude provider is set by default to the Propagator.getDefaultLaw(Frames) DEFAULT_LAW}.
The mass is set by default to the DEFAULT_MASS.
The ECI frame is set by default to the EME2000 frame.
The ECEF frame is set by default to the Frames.getITRF(IERSConventions, boolean) CIO/2010-based ITRF simple EOP}.

Parameters:

gpsOrbElt - the GPS orbital elements to be used by the GPSpropagator.

frames - set of frames to use.

Since:

10.1

See Also:

attitudeProvider(AttitudeProvider provider), mass(double mass), eci(Frame inertial), ecef(Frame bodyFixed)

Method Detail

attitudeProvider

public GPSPropagator.Builder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public GPSPropagator.Builder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public GPSPropagator.Builder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public GPSPropagator.Builder ecef(Frame bodyFixed)

Sets the Earth Centered Earth Fixed frame assimilated to the WGS84 ECEF.

Parameters:

bodyFixed - the ECEF frame

Returns:

the updated builder

build

public GPSPropagator build()

Finalizes the build.

Returns:

the built GPSPropagator