Package org.orekit.propagation.analytical.gnss

Class GLONASSAnalyticalPropagatorBuilder

java.lang.Object

org.orekit.propagation.analytical.gnss.GLONASSAnalyticalPropagatorBuilder

public class GLONASSAnalyticalPropagatorBuilder
extends Object

This nested class aims at building a GLONASSAnalyticalPropagator.

It implements the classical builder pattern.

Caution: The Glonass analytical propagator can only be used with GLONASSAlmanac. Using this propagator with a GLONASSNavigationMessage is prone to error.

Since:

11.0

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor	Description
GLONASSAnalyticalPropagatorBuilder(GLONASSOrbitalElements glonassOrbElt)	Initializes the builder.
GLONASSAnalyticalPropagatorBuilder(GLONASSOrbitalElements glonassOrbElt, DataContext dataContext)	Initializes the builder.

Method Summary

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

GLONASSAnalyticalPropagatorBuilder

@DefaultDataContext
public GLONASSAnalyticalPropagatorBuilder(GLONASSOrbitalElements glonassOrbElt)

Initializes the builder.

The GLONASS orbital elements is the only requested parameter to build a GLONASSAnalyticalPropagator.

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 data context is by default to the default data context.
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 GLONASSOrbitalElements gpsOrbElt, final DataContext dataContext)

Parameters:

glonassOrbElt - the GLONASS orbital elements to be used by the GLONASS analytical propagator.

See Also:

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

GLONASSAnalyticalPropagatorBuilder

public GLONASSAnalyticalPropagatorBuilder(GLONASSOrbitalElements glonassOrbElt,
                                          DataContext dataContext)

Initializes the builder.

The GLONASS orbital elements is the only requested parameter to build a GLONASSAnalyticalPropagator.

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 CIO/2010-based ITRF simple EOP.

Parameters:

glonassOrbElt - the GLONASS orbital elements to be used by the GLONASS propagator.

dataContext - the data context to use for frames and time scales.

Since:

10.1

See Also:

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

Method Detail

attitudeProvider

public GLONASSAnalyticalPropagatorBuilder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public GLONASSAnalyticalPropagatorBuilder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public GLONASSAnalyticalPropagatorBuilder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public GLONASSAnalyticalPropagatorBuilder ecef(Frame bodyFixed)

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

Parameters:

bodyFixed - the ECEF frame

Returns:

the updated builder

dataContext

public GLONASSAnalyticalPropagatorBuilder dataContext(DataContext context)

Sets the data context used by the propagator. Does not update the ECI or ECEF frames which must be done separately using eci(Frame) and ecef(Frame).

Parameters:

context - used for propagation.

Returns:

the updated builder.

build

public GLONASSAnalyticalPropagator build()

Finalizes the build.

Returns:

the built GLONASSPropagator