Changes

Page history
Mise à jour de Satellite authored by Julien LEBLOND's avatar Julien LEBLOND
Show whitespace changes
Inline Side-by-side
Satellite.md
View page @ bda49826
......@@ -113,35 +113,23 @@ This page describes the content of a CZML document. Please read [Get Started](Ge
These arguments can be used to build a satellite object :
**Ephemeris** - [List of TimeStampedPVCoordinates](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/OemData.html#getEphemeridesDataLines()) : Lines of ephemerides from an oem file.
**propagator** - [BoundedPropagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/BoundedPropagator.html) : A propagator/ephemeris extracted from an already made propagation.
**Frame** - [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html) : An Orekit frame
**startDateInput** - [AbsoluteDate](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/time/AbsoluteDate.html) : The start date when the satellite must be displayed.
**SpacecraftStateListInput** - [List of SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html) : An orekit list of SpacecraftState
**finalDateInput** - [AbsoluteDate](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/time/AbsoluteDate.html) : The stop date when the satellite must not be displayed (or end of the simulation).
**modelPath** - The path to the model used to represents the satellite.
## Other parameters
**period** - double : The period of the satellite in its orbit.
**timePosition** - [TimePosition](TimePosition) : An object specified for the satellite that contains for example the reference frame used or the position in time of the satellite in the given frame.
**timeList** - [List of Double](https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html) : This list contains all the double that separate the initial julian date to the current date.
**absoluteDateList** - [List of AbsoluteDate](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/time/AbsoluteDate.html) : This list contains all the Orekit absoluteDate objects that represents the different instants when the simulations takes place.
**Orientation** - [Orientation](Orientation)\*\* : The orientation object, defines the orientation in time of the satellite.
**cartesianArraylist** - [List of Cartesian](https://github.com/AnalyticalGraphicsInc/czml-writer/wiki/Cartesian3Value) : This list contains all the Cartesian objects that defines the position in time of the satellite in the ITRF.
**orbits** - [List of Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html) : This list contains all the orbits computed of the satellite, for the duration of the simulation.
**Billboard** - [Billboard](Billboard) : A 2D object that allows to display a given image to represents the satellite. _default_ : A 2D image representing a satellite will be used.
**positionList** - [List of Position](Position) : The list of all the position packet objects, they defined the position of the satellite in time, this object is used for writing in the czml file.
(To be deleted) **boundedPropagator** - [BoundedPropagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/BoundedPropagator.html) : The bounded propagator object of the satellite used for the propagation.
**propagator** - [Propagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/Propagator.html) : The propagator used for the propagation of the satellite.
**propagator** - [Propagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/Propagator.html) : The propagator used for the propagation of the satellite. It is not the same as the bounded propagator used to build the satellite.
**attitudes** - [List of Attitude](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/attitudes/Attitude.html) : The list of all the Orekit Attitude objects. They represents the orientation in the local orbital frame of the satellite.
......@@ -153,150 +141,13 @@ These arguments can be used to build a satellite object :
# Build
The satellite object can be build with :
* An [Oem](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/Oem.html), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(file, color);
The satellite object can be build with only a bounded propagator. In order to build the satellite you should use the [satellite builder](SatelliteBuilder), you can use it like this :
```java
final Satellite satellite = Satellite.builder(propagator).build();
```
* An [Oem](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/Oem.html), a path to a 3D model (String) :
This way you can add a color to the orbit, or a model for the satellite like this :
```Java
Satellite satellite = new Satellite(file, model3DPath);
```java
final Satellite satellite = Satellite.builder(propagator).withModel(modelPath).withColor(color).build();
```
\ No newline at end of file
* An [Oem](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/Oem.html), a path to a 3D model (String), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(file, model3DPath, color);
```
* A [TLE](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/analytical/tle/TLE.html) :
```Java
Satellite satellite = new Satellite(tle);
```
* A [TLE](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/analytical/tle/TLE.html), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(tle, color);
```
* A [TLE](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/analytical/tle/TLE.html), a path to a 3D model (String):
```Java
Satellite satellite = new Satellite(tle, model3DPath);
```
* A [TLE](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/analytical/tle/TLE.html), a path to a 3D model (String), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(tle, model3DPath, color);
```
* An [Availability](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html), an [Ephemeris](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/OemData.html#getEphemeridesDataLines()), a [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html) :
```Java
Satellite satellite = new Satellite(availability, ephemeris, frame);
```
* A name, an [Availability](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html), a description, an [Ephemeris](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/OemData.html#getEphemeridesDataLines()), a [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html) :
```Java
Satellite satellite = new Satellite(name, availability, description, ephemeris, frame);
```
* A name, an [Availability](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html), a description, an [Ephemeris](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/OemData.html#getEphemeridesDataLines()), a [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html%7D) a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, color);
```
* A name, an [Availability](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html), a description, an [Ephemeris](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/OemData.html#getEphemeridesDataLines()), a [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html), a path to a 3D model (String) :
```Java
Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, model3DPath);
```
* A name, an [Availability](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html), a description, an [Ephemeris](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/files/ccsds/ndm/odm/oem/OemData.html#getEphemeridesDataLines()), a [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html), a path to a 3D model (String), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, model3DPath, color);
```
* An [Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html) :
```Java
Satellite satellite = new Satellite(orbit);
```
* An [Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(orbit, color);
```
* An [Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html), a path to a 3D model (String):
```Java
Satellite satellite = new Satellite(orbit, model3DPath);
```
* An [Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html), a path to a 3D model (String), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(orbit, model3DPath, color);
```
* A [List of SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html) :
```Java
Satellite satellite = new Satellite(spacecraftStateList);
```
* A [List of SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(spacecraftStateList, color);
```
* A [List of SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html), a path to a 3D model (String) :
```Java
Satellite satellite = new Satellite(spacecraftStateList, model3DPath);
```
* A [List of SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html), a path to a 3D model (String), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(spacecraftStateList, model3DPath, color);
```
* A [Propagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/Propagator.html), An [AbsoluteDate](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/time/AbsoluteDate.html) (finalDate of display), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(propagator, finalDate, color);
```
* A [Propagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/Propagator.html), An [AbsoluteDate](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/time/AbsoluteDate.html) (finalDate of display), a path to a 3D model (String) :
```Java
Satellite satellite = new Satellite(propagator, finalDate, model3DPath);
```
* A [Propagator](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/Propagator.html), An [AbsoluteDate](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/time/AbsoluteDate.html) (finalDate of display), a path to a 3D model (String), a [Color](https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html) :
```Java
Satellite satellite = new Satellite(propagator, finalDate, model3DPath, color);
```
# Functions
`displayOnlyOnePeriod()` - void : Displays only one period of the satellite at a time during the simulation, for a clearer visual.
`displaySatelliteAttitude` - void : Displays the attitude of the satellite in time.
`displaySatelliteReferenceSystem` - void : Displays the orbital reference system of the satellite.
\ No newline at end of file