org.orekit.propagation.analytical.gnss

Class GNSSPropagatorBuilder

java.lang.Object

org.orekit.propagation.analytical.gnss.GNSSPropagatorBuilder

public class GNSSPropagatorBuilder
extends Object

This nested class aims at building a GNSSPropagator.

It implements the classical builder pattern.

Since:

11.0

Author:

Pascal Parraud

Constructor Summary

Constructors

Constructor and Description
GNSSPropagatorBuilder(GNSSOrbitalElements gnssOrbElt) Initializes the builder.
GNSSPropagatorBuilder(GNSSOrbitalElements gnssOrbElt, Frames frames) Initializes the builder.

Method Summary

Modifier and Type	Method and Description
GNSSPropagatorBuilder	attitudeProvider(AttitudeProvider userProvider) Sets the attitude provider.
GNSSPropagator	build() Finalizes the build.
GNSSPropagatorBuilder	ecef(Frame bodyFixed) Sets the Earth Centered Earth Fixed frame assimilated to the WGS84 ECEF.
GNSSPropagatorBuilder	eci(Frame inertial) Sets the Earth Centered Inertial frame used for propagation.
GNSSPropagatorBuilder	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

GNSSPropagatorBuilder

@DefaultDataContext
public GNSSPropagatorBuilder(GNSSOrbitalElements gnssOrbElt)

Initializes the builder.

The GNSS orbital elements is the only requested parameter to build a GNSSPropagator.

The attitude provider is set by default to be aligned with the EME2000 frame.
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 GNSSOrbitalElements gpsOrbElt, final Frames frames)

Parameters:

gnssOrbElt - the GNSS orbital elements to be used by the GNSSpropagator.

See Also:

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

GNSSPropagatorBuilder

public GNSSPropagatorBuilder(GNSSOrbitalElements gnssOrbElt,
                             Frames frames)

Initializes the builder.

The GNSS orbital elements is the only requested parameter to build a GNSSPropagator.

The attitude provider is set by default to be aligned with the EME2000 frame.
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:

gnssOrbElt - the GNSS orbital elements to be used by the GNSSpropagator.

frames - set of frames to use.

See Also:

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

Method Detail

attitudeProvider

public GNSSPropagatorBuilder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public GNSSPropagatorBuilder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public GNSSPropagatorBuilder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public GNSSPropagatorBuilder 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 GNSSPropagator build()

Finalizes the build.

Returns:

the built GNSSPropagator