Changes

Page history
Mise à jour de Satellite authored by Julien LEBLOND's avatar Julien LEBLOND
Hide whitespace changes
Inline Side-by-side
Satellite.md
View page @ 887ecd5a
...@@ -5,6 +5,7 @@ This page describes the content of a CZML document. Please read [Get Started](ht ...@@ -5,6 +5,7 @@ This page describes the content of a CZML document. Please read [Get Started](ht
**Implements** : [CZMLPrimaryObject](https://gitlab.orekit.org/Zudo/oreczml/-/wikis/CZMLPrimaryObjects) **Implements** : [CZMLPrimaryObject](https://gitlab.orekit.org/Zudo/oreczml/-/wikis/CZMLPrimaryObjects)
**Example** : **Example** :
```json ```json
{ {
"id":"Keplerian parameters: {a: 6928000.0; e: 0.0; i: 60.00000000000001; pa: 0.0; raan: 90.0; v: 90.0;}", "id":"Keplerian parameters: {a: 6928000.0; e: 0.0; i: 60.00000000000001; pa: 0.0; raan: 90.0; v: 90.0;}",
...@@ -98,17 +99,17 @@ This page describes the content of a CZML document. Please read [Get Started](ht ...@@ -98,17 +99,17 @@ This page describes the content of a CZML document. Please read [Get Started](ht
**id** - String : Identification of the satellite **id** - String : Identification of the satellite
**name** - String : Name of the satellite, *default* : "Satellite". **name** - String : Name of the satellite, _default_ : "Satellite".
**availability** - [TimeInterval](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html) : Time interval when the satellite is displayed. **availability** - [TimeInterval](https://cesium.com/learn/cesiumjs/ref-doc/TimeInterval.html) : Time interval when the satellite is displayed.
**description** - String : An optional description of the satellite, *default* : "A satellite". **description** - String : An optional description of the satellite, _default_ : "A satellite".
**model** - [Model3D](Model3D) : An optional 3D model of the satellite, **default** : A 2D image representing a satellite will be used. **model** - [Model3D](Model3D) : An optional 3D model of the satellite, **default** : A 2D image representing a satellite will be used.
**path** - [Path](path) : An object that represents the path of the satellite, can be used to represents how long the path made by the satellite will be displayed. **path** - [Path](path) : An object that represents the path of the satellite, can be used to represents how long the path made by the satellite will be displayed.
**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. **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.
**SatellitePosition** - [SatellitePosition](SatellitePosition) : 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. **SatellitePosition** - [SatellitePosition](SatellitePosition) : 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.
...@@ -116,68 +117,160 @@ This page describes the content of a CZML document. Please read [Get Started](ht ...@@ -116,68 +117,160 @@ This page describes the content of a CZML document. Please read [Get Started](ht
These arguments can be used to build a satellite object : These arguments can be used to build a satellite object :
**Ephemeris** - [List<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. **Ephemeris** - [List](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.
**Frame** - [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html) : An Orekit frame **Frame** - [Frame](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/frames/Frame.html) : An Orekit frame
**OrbitInput** - [OrbitInput](OrbitInput) : An object created with a given orbit inputted **OrbitInput** - [OrbitInput](OrbitInput) : An object created with a given orbit inputted
**SpacecraftStateListInput** - [SpacecraftStateListInput](SpacecraftStateListInput) : An object created with a given list of [SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html) is inputted **SpacecraftStateListInput** - [SpacecraftStateListInput](SpacecraftStateListInput) : An object created with a given list of [SpacecraftState](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/propagation/SpacecraftState.html) is inputted
# Build # Build
The satellite object can be build with : The satellite object can be build with :
* An [OEMFile](OEMFile), a [Header](Header) : * 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);
```
* 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) :
```Java
Satellite satellite = new Satellite(file, model3DPath);
```
* 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 ```Java
Satellite satellite = new Satellite(file, header); Satellite satellite = new Satellite(name, availability, description, ephemeris, frame);
``` ```
* An [OEMFile](OEMFile), a [Header](Header), a path to a 3D model (String) : * 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 ```Java
Satellite satellite = new Satellite(file, header, model3DPath); Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, color);
``` ```
* A [Header](Header), a name, an availability, a description, an Ephemeris, a 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), a path to a 3D model (String) :
```Java ```Java
Satellite satellite = new Satellite(header, name, availability, description, ephemeris, frame); Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, model3DPath);
``` ```
* A [Header](Header), a name, an availability, a description, an Ephemeris, a Frame, a path to a 3D model : * 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 ```Java
Satellite satellite = new Satellite(header, name, availability, description, ephemeris, frame, model3DPath); Satellite satellite = new Satellite(name, availability, description, ephemeris, frame, model3DPath, color);
``` ```
* An [OrbitInput](OrbitInput), a [Header](Header) : * An [Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html) :
```Java ```Java
Satellite satellite = new Satellite(orbitInput, header); Satellite satellite = new Satellite(orbit);
``` ```
* An [OrbitInput](OrbitInput), a [Header](Header), a path to a 3D model : * 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 ```Java
Satellite satellite = new Satellite(orbitInput, header, model3DPath); Satellite satellite = new Satellite(orbit, color);
``` ```
* A [SpacecraftStateListInput](SpacecraftStateListInput), a [Header](Header) : * An [Orbit](https://www.orekit.org/site-orekit-development/apidocs/org/orekit/orbits/Orbit.html), a path to a 3D model (String):
```Java ```Java
Satellite satellite = new Satellite(spacecraftStateListInput, header); Satellite satellite = new Satellite(orbit, model3DPath);
``` ```
* A [SpacecraftStateListInput](SpacecraftStateListInput), a [Header](Header), a path to a 3D model : * 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 ```Java
Satellite satellite = new Satellite(spacecraftStateListInput, header, model3DPath); Satellite satellite = new Satellite(orbit, 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 [Header](Header) : * 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 ```Java
Satellite satellite = new Satellite(propagator, finalDate, header); Satellite satellite = new Satellite(spacecraftStateList, 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 [Header](Header), a path to a 3D model : * 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 ```Java
Satellite satellite = new Satellite(propagator, finalDate, header, model3DPath); 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 # Functions
displayOnlyOnePeriod() - void : Displays only one period of the satellite at a time during the simulation, for a clearer visual. `displayOnlyOnePeriod()` - void : Displays only one period of the satellite at a time during the simulation, for a clearer visual.
\ No newline at end of file
`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