org.orekit.propagation.analytical.gnss

Class BeidouPropagator.Builder

java.lang.Object

org.orekit.propagation.analytical.gnss.BeidouPropagator.Builder

Enclosing class:

BeidouPropagator

public static class BeidouPropagator.Builder
extends Object

This nested class aims at building a BeidouPropagator.

It implements the classical builder pattern.

Constructor Summary

Constructors

Constructor and Description
Builder(BeidouOrbitalElements bdsOrbElt) Initializes the builder.
Builder(BeidouOrbitalElements bdsOrbElt, Frames frames) Initializes the builder.

Method Summary

Modifier and Type	Method and Description
BeidouPropagator.Builder	attitudeProvider(AttitudeProvider userProvider) Sets the attitude provider.
BeidouPropagator	build() Finalizes the build.
BeidouPropagator.Builder	ecef(Frame bodyFixed) Sets the Earth Centered Earth Fixed frame.
BeidouPropagator.Builder	eci(Frame inertial) Sets the Earth Centered Inertial frame used for propagation.
BeidouPropagator.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(BeidouOrbitalElements bdsOrbElt)

Initializes the builder.

The Beidou orbital elements is the only requested parameter to build a BeidouPropagator.

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

Parameters:

bdsOrbElt - the Beidou orbital elements to be used by the Beidou propagator.

See Also:

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

Builder

public Builder(BeidouOrbitalElements bdsOrbElt,
               Frames frames)

Initializes the builder.

The Beidou orbital elements is the only requested parameter to build a BeidouPropagator.

The attitude provider is set by default to the DEFAULT_LAW.
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:

bdsOrbElt - the Beidou orbital elements to be used by the Beidou propagator.

frames - set of frames to use building the propagator.

Since:

10.1

See Also:

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

Method Detail

attitudeProvider

public BeidouPropagator.Builder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public BeidouPropagator.Builder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public BeidouPropagator.Builder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

public BeidouPropagator.Builder ecef(Frame bodyFixed)

Sets the Earth Centered Earth Fixed frame.

Parameters:

bodyFixed - the ECEF frame

Returns:

the updated builder

build

public BeidouPropagator build()

Finalizes the build.

Returns:

the built BeidouPropagator