org.orekit.propagation.analytical.gnss

Class IRNSSPropagator.Builder

java.lang.Object

org.orekit.propagation.analytical.gnss.IRNSSPropagator.Builder

Enclosing class:

IRNSSPropagator

public static class IRNSSPropagator.Builder
extends Object

This nested class aims at building a IRNSSPropagator.

It implements the classical builder pattern.

Constructor Summary

Constructors

Constructor and Description
Builder(IRNSSOrbitalElements irnssOrbElt, Frames frames) Initializes the builder.

Method Summary

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

public Builder(IRNSSOrbitalElements irnssOrbElt,
               Frames frames)

Initializes the builder.

The IRNSS orbital elements is the only requested parameter to build a IRNSSPropagator.

The attitude provider is set by default to be aligned with the J2000 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:

irnssOrbElt - the IRNSS orbital elements to be used by the IRNSSpropagator.

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

See Also:

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

Method Detail

attitudeProvider

public IRNSSPropagator.Builder attitudeProvider(AttitudeProvider userProvider)

Sets the attitude provider.

Parameters:

userProvider - the attitude provider

Returns:

the updated builder

mass

public IRNSSPropagator.Builder mass(double userMass)

Sets the mass.

Parameters:

userMass - the mass (in kg)

Returns:

the updated builder

eci

public IRNSSPropagator.Builder eci(Frame inertial)

Sets the Earth Centered Inertial frame used for propagation.

Parameters:

inertial - the ECI frame

Returns:

the updated builder

ecef

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

Finalizes the build.

Returns:

the built IRNSSPropagator