org.orekit.propagation.analytical.gnss

Class QZSSPropagator.Builder

java.lang.Object

org.orekit.propagation.analytical.gnss.QZSSPropagator.Builder

Enclosing class:

QZSSPropagator

public static class QZSSPropagator.Builder
extends Object

This nested class aims at building a QZSSPropagator.

It implements the classical builder pattern.

Constructor Summary

Constructors

Constructor and Description
Builder(QZSSOrbitalElements qzssOrbElt) Initializes the builder.
Builder(QZSSOrbitalElements qzssOrbElt, Frames frames) Initializes the builder.

Method Summary

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

Initializes the builder.

The QZSS orbital elements is the only requested parameter to build a QZSSPropagator.

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 QZSSOrbitalElements gpsOrbElt, final Frames frames)

Parameters:

qzssOrbElt - the QZSS orbital elements to be used by the QZSSpropagator.

See Also:

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

Builder

public Builder(QZSSOrbitalElements qzssOrbElt,
               Frames frames)

Initializes the builder.

The QZSS orbital elements is the only requested parameter to build a QZSSPropagator.

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

Parameters:

qzssOrbElt - the QZSS orbital elements to be used by the QZSSpropagator.

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 QZSSPropagator.Builder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public QZSSPropagator.Builder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public QZSSPropagator.Builder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public QZSSPropagator.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 QZSSPropagator build()

Finalizes the build.

Returns:

the built QZSSPropagator