FramesConfigurationBuilder (patrius 4.0 API)

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

java.lang.Object
- fr.cnes.sirius.patrius.frames.configuration.FramesConfigurationBuilder

```
public final class FramesConfigurationBuilder
extends Object
```
Frame configuration builder utility, to assist the user in creating a FramesConfiguration. Two constructors exist.
The first one doesnt take any parameters and when called, creates an internal FramesConfigurationImplementation that is initialized with no model, see NO_TIDE, NO_LIBRATION, NO_PN and NoEOP2000History.
The second one takes a FramesConfiguration as an input argument, and initializes the new internal FramesConfiguration with the models from the user specified one.

Since:: 1.3
Version:: $Id: FramesConfigurationBuilder.java 18073 2017-10-02 16:48:07Z bignon $
Author:: Julie Anton, Rami Houdroge

Constructor Summary

Constructors
Constructor and Description

FramesConfigurationBuilder()
Public default constructor.

FramesConfigurationBuilder(FramesConfiguration configIn)
Public constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`FramesConfiguration`	`getConfiguration()` Configuration builder using the current builder providers.
`void`	`setDiurnalRotation(DiurnalRotation diurnalRotationModel)` Setter for diurnal rotation provider in the builder.
`void`	`setEOPHistory(EOPHistory history)` Setter for history provider in the builder.
`void`	`setPolarMotion(PolarMotion polarMotionModel)` Setter for polar motion provider in the builder.
`void`	`setPrecessionNutation(PrecessionNutation precessionNutationModel)` Setter for precession nutation provider in the builder.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FramesConfigurationBuilder
```
public FramesConfigurationBuilder()
```
    Public default constructor.
  - FramesConfigurationBuilder
```
public FramesConfigurationBuilder(FramesConfiguration configIn)
```
    Public constructor.
    
    Parameters:
    configIn - user configuration
- Method Detail
  - setEOPHistory
```
public void setEOPHistory(EOPHistory history)
```
    Setter for history provider in the builder.
    
    Parameters:
    history - history provider
  - setPolarMotion
```
public void setPolarMotion(PolarMotion polarMotionModel)
```
    Setter for polar motion provider in the builder.
    
    Parameters:
    polarMotionModel - polar motion provider
  - setDiurnalRotation
```
public void setDiurnalRotation(DiurnalRotation diurnalRotationModel)
```
    Setter for diurnal rotation provider in the builder.
    
    Parameters:
    diurnalRotationModel - diurnal rotation provider
  - setPrecessionNutation
```
public void setPrecessionNutation(PrecessionNutation precessionNutationModel)
```
    Setter for precession nutation provider in the builder.
    
    Parameters:
    precessionNutationModel - precession nutation provider
  - getConfiguration
```
public FramesConfiguration getConfiguration()
```
    Configuration builder using the current builder providers. Always returns a new instance. The attribute config is reinitialized here.
    
    Returns:
    a new FramesConfiguration instance

All Classes

Summary:
Nested |
Field |
Constr |
Method

Detail:
Field |
Constr |
Method

Copyright © 2017 CNES. All rights reserved.