Package org.orekit.propagation.analytical.gnss

Class FieldGnssPropagatorBuilder<T extends CalculusFieldElement<T>>

java.lang.Object

org.orekit.propagation.analytical.gnss.FieldGnssPropagatorBuilder<T>

Type Parameters:

T - type of the field elements

public class FieldGnssPropagatorBuilder<T extends CalculusFieldElement<T>>
extends Object

This nested class aims at building a GNSSPropagator.

It implements the classical builder pattern.

Since:

13.0

Author:

Pascal Parraud

Constructor Summary

Constructors

Constructor	Description
FieldGnssPropagatorBuilder(FieldGnssOrbitalElements<T,?> orbitalElements)	Initializes the builder.
FieldGnssPropagatorBuilder(FieldGnssOrbitalElements<T,?> orbitalElements, Frames frames)	Initializes the builder.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

FieldGnssPropagatorBuilder

@DefaultDataContext
public FieldGnssPropagatorBuilder(FieldGnssOrbitalElements<T,?> orbitalElements)

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:

orbitalElements - the GNSS orbital elements to be used by the propagator.

See Also:

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

FieldGnssPropagatorBuilder

public FieldGnssPropagatorBuilder(FieldGnssOrbitalElements<T,?> orbitalElements,
                                  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:

orbitalElements - orbital elements

frames - set of frames to use.

See Also:

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

Method Detail

attitudeProvider

public FieldGnssPropagatorBuilder<T> attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public FieldGnssPropagatorBuilder<T> mass(T userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public FieldGnssPropagatorBuilder<T> eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public FieldGnssPropagatorBuilder<T> 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 FieldGnssPropagator<T> build()

Finalizes the build.

Returns:

the built GNSSPropagator