org.orekit.propagation.analytical.gnss

Class SBASPropagatorBuilder

java.lang.Object

org.orekit.propagation.analytical.gnss.SBASPropagatorBuilder

public class SBASPropagatorBuilder
extends Object

This nested class aims at building a SBASPropagator.

It implements the classical builder pattern.

Since:

11.0

Author:

Bryan Cazabonne

Constructor Summary

Constructors

Constructor and Description
SBASPropagatorBuilder(SBASOrbitalElements sbasOrbElt) Initializes the builder.
SBASPropagatorBuilder(SBASOrbitalElements sbasOrbElt, Frames frames) Initializes the builder.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SBASPropagatorBuilder

@DefaultDataContext
public SBASPropagatorBuilder(SBASOrbitalElements sbasOrbElt)

Initializes the builder.

The SBAS orbital elements is the only requested parameter to build a SBASPropagator.

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

This constructor uses the default data context.

Parameters:

sbasOrbElt - the SBAS orbital elements to be used by the SBAS propagator.

Since:

12.0

See Also:

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

SBASPropagatorBuilder

public SBASPropagatorBuilder(SBASOrbitalElements sbasOrbElt,
                             Frames frames)

Initializes the builder.

The SBAS orbital elements is the only requested parameter to build a SBASPropagator.

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

sbasOrbElt - the SBAS orbital elements to be used by the SBAS propagator.

frames - set of reference frames to use to initialize ecef(Frame), eci(Frame), and attitudeProvider(AttitudeProvider).

See Also:

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

Method Detail

attitudeProvider

public SBASPropagatorBuilder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mu

public SBASPropagatorBuilder mu(double coefficient)

Sets the Earth gravity coefficient.

Parameters:

coefficient - the Earth gravity coefficient

Returns:

the updated builder

mass

public SBASPropagatorBuilder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public SBASPropagatorBuilder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public SBASPropagatorBuilder 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 SBASPropagator build()

Finalizes the build.

Returns:

the built SBASPropagator