User Manual 4.0 SpacecraftState - Historique des versions

Admin le 21 février 2018 à 14:00

2018-02-21T14:00:03Z

← Version précédente		Version du 21 février 2018 à 14:00
Ligne 5 :		Ligne 5 :

	=== Javadoc ===		=== Javadoc ===
	The object [{{~~PathCurrentJavaDoc~~}}//fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is available in the package <code>fr.cnes.sirius.patrius.propagation</code>.		The object [{{JavaDoc4.0}}//fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is available in the package <code>fr.cnes.sirius.patrius.propagation</code>.


Ligne 16 :		Ligne 16 :

	=== Overview ===		=== Overview ===
	The [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of :<br>		The [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of :<br>
	- an [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/orbits/Orbit.html orbit]<br>		- an [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/orbits/Orbit.html orbit]<br>
	- an [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for forces computation] <br>		- an [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for forces computation] <br>
	- an [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for events computation]<br>		- an [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for events computation]<br>
	- a map of additional states (including mass states added from [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider]).<br>		- a map of additional states (including mass states added from [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider]).<br>

	Two attitudes are stored in order to apply (if needed) a different treatment to each attitude.		Two attitudes are stored in order to apply (if needed) a different treatment to each attitude.
Ligne 26 :		Ligne 26 :
	== Features Description ==		== Features Description ==
	=== One orbit ===		=== One orbit ===
	The [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of one [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/orbits/Orbit.html Orbit].		The [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of one [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/orbits/Orbit.html Orbit].
	It is possible to simply declare a SpacecraftState with an orbit :		It is possible to simply declare a SpacecraftState with an orbit :
	<code>final SpacecraftState state = new SpacecraftState(orbit);</code>		<code>final SpacecraftState state = new SpacecraftState(orbit);</code>
Ligne 37 :		Ligne 37 :
	The user can use one single		The user can use one single

	[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/attitudes/Attitude.html Attitude] or two different [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/attitudes/Attitude.html Attitude] objects : one for forces computation and one for events computation. The following constructor can be used :		[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/attitudes/Attitude.html Attitude] or two different [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/attitudes/Attitude.html Attitude] objects : one for forces computation and one for events computation. The following constructor can be used :

	<code>final SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents);</code>		<code>final SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents);</code>
Ligne 69 :		Ligne 69 :

	=== Mass ===		=== Mass ===
	A [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider] can be provided to the SpacecraftState. In that case, the mass information are automaticaly stored as additional states. Be careful, the mass values can never be negative:		A [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider] can be provided to the SpacecraftState. In that case, the mass information are automaticaly stored as additional states. Be careful, the mass values can never be negative:

	<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit, massProvider);		<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit, massProvider);
Ligne 90 :		Ligne 90 :

	=== State vector ===		=== State vector ===
	The [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] object could be created from a state vector :		The [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] object could be created from a state vector :
	<code>final SpacecraftState state = new SpacecraftState(stateVector, OrbitType.CARTESIAN, PositionAngle.MEAN, date, mu, frame, addStatesInfo, attProviderForces, attProviderEvents);</code>		<code>final SpacecraftState state = new SpacecraftState(stateVector, OrbitType.CARTESIAN, PositionAngle.MEAN, date, mu, frame, addStatesInfo, attProviderForces, attProviderEvents);</code>

Ligne 102 :		Ligne 102 :
	=== Transform ===		=== Transform ===

	The [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] class contains methods to compute the following transformations :		The [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] class contains methods to compute the following transformations :
	- <code>toTransform()</code> or <code>toTransformForces()</code> : Transform from orbit/attitude reference frame to spacecraft frame (attitude used for forces computation which is the default attitude).<br>		- <code>toTransform()</code> or <code>toTransformForces()</code> : Transform from orbit/attitude reference frame to spacecraft frame (attitude used for forces computation which is the default attitude).<br>
	- <code>toTransformEvents()</code> : Transform from orbit/attitude reference frame to spacecraft frame attitude used for events computation (same as toTransform if there is no specific attitude for Events).		- <code>toTransformEvents()</code> : Transform from orbit/attitude reference frame to spacecraft frame attitude used for events computation (same as toTransform if there is no specific attitude for Events).
	- <code>toTransform(Frame)</code> or <code>toTransformForces(Frame)</code> : Transform from specified [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame (attitude used for forces computation which is the default attitude).<br>		- <code>toTransform(Frame)</code> or <code>toTransformForces(Frame)</code> : Transform from specified [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame (attitude used for forces computation which is the default attitude).<br>
	- <code>toTransformEvents(Frame)</code> : Transform from specified [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame attitude used for events computation (same as toTransform(Frame) if there is no attitude specific for Events).<br>		- <code>toTransformEvents(Frame)</code> : Transform from specified [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame attitude used for events computation (same as toTransform(Frame) if there is no attitude specific for Events).<br>
	- <code>toTransform(LOFType)</code> : Transform from orbit/attitude reference frame to local orbital frame ([{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).<br>		- <code>toTransform(LOFType)</code> : Transform from orbit/attitude reference frame to local orbital frame ([{{JavaDoc4.0}}/fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).<br>
	- <code>toTransform(Frame, LOFType)</code> : Transform from specified [{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to local orbital frame ([{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).<br>		- <code>toTransform(Frame, LOFType)</code> : Transform from specified [{{JavaDoc4.0}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to local orbital frame ([{{JavaDoc4.0}}/fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).<br>

	== Getting Started ==		== Getting Started ==
Ligne 132 :		Ligne 132 :
	final Vector3D pos = transform.transformPosition(sun.getPVCoordinates().getPosition());		final Vector3D pos = transform.transformPosition(sun.getPVCoordinates().getPosition());
	</syntaxhighlight>		</syntaxhighlight>
	If an [{{~~PathCurrentJavaDoc~~}}//fr/cnes/sirius/patrius/assembly/Assembly.html Assembly] is used, this is not necessary to use these methods because the conversion methods are included in Assembly functionalities (see [SPC_VBU_Home dedicated User Manual]).		If an [{{JavaDoc4.0}}//fr/cnes/sirius/patrius/assembly/Assembly.html Assembly] is used, this is not necessary to use these methods because the conversion methods are included in Assembly functionalities (see [SPC_VBU_Home dedicated User Manual]).

	== Contents ==		== Contents ==

Admin : /* Classes */

2018-02-21T07:57:38Z

Classes

← Version précédente		Version du 21 février 2018 à 07:57
Ligne 150 :		Ligne 150 :
	=== Classes ===		=== Classes ===

	\|=~~(% colspan~~="3" %)Class~~\|=(% colspan~~="6" %)Summary~~\|=(% colspan~~="1" %)Javadoc		{\| class="wikitable"
	\|~~(% colspan="3" %)~~'''SpacecraftState'''\|~~(% colspan="6" %)~~This class is the representation of a complete state holding orbit, attitude for forces and for events computation and additional states at a given date.\|~~(% colspan="1" %)~~[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html ...]		\|-
	\|~~(% colspan="3" %)~~'''Attitude'''\|~~(% colspan="6" %)~~Object representing the attitude of the spacecraft for a specific date and in a specific frame.\|~~(% colspan="1" %)~~[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/attitudes/Attitude.html ...]		! scope="col"\| Class
			! scope="col"\| Summary
			! scope="col"\| Javadoc
			\|-
			\|'''SpacecraftState'''
			\|This class is the representation of a complete state holding orbit, attitude for forces and for events computation and additional states at a given date.
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html ...]
			\|-
			\|'''Attitude'''
			\|Object representing the attitude of the spacecraft for a specific date and in a specific frame.
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/attitudes/Attitude.html ...]
			\|}

	[[Category:User_Manual_4.0_Flight_Dynamics]]		[[Category:User_Manual_4.0_Flight_Dynamics]]

Admin : /* Interfaces */

2018-02-21T07:57:02Z

Interfaces

← Version précédente		Version du 21 février 2018 à 07:57
Ligne 136 :		Ligne 136 :
	== Contents ==		== Contents ==
	=== Interfaces ===		=== Interfaces ===
	\|=~~(% colspan~~="3" %)Interface~~\|=(% colspan~~="6" %)Summary~~\|=(% colspan~~="1" %)Javadoc
	\|~~(% colspan="3" %)~~'''MassProvider'''\|~~(% colspan="6" %)~~Interface providing the mass for spacecraft models.\|[{{~~PathCurrentJavaDoc~~}}/fr/cnes/sirius/patrius/propagation/MassProvider.html ...]		{\| class="wikitable"
			\|-
			! scope="col"\| Interface
			! scope="col"\| Summary
			! scope="col"\| Javadoc
			\|-
			\|'''MassProvider'''
			\|Interface providing the mass for spacecraft models.
			\|[{{JavaDoc4.0}}/fr/cnes/sirius/patrius/propagation/MassProvider.html ...]
			\|}

	=== Classes ===		=== Classes ===

Admin le 20 février 2018 à 16:42

2018-02-20T16:42:44Z

← Version précédente		Version du 20 février 2018 à 16:42
Ligne 1 :		Ligne 1 :
			__NOTOC__

	== Introduction ==		== Introduction ==
	=== Scope ===		=== Scope ===

Admin le 19 février 2018 à 08:51

2018-02-19T08:51:29Z

← Version précédente		Version du 19 février 2018 à 08:51
Ligne 17 :		Ligne 17 :

	=== Overview ===		=== Overview ===
	The [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of :		The [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of :<br>
	- an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/orbits/Orbit.html orbit]		- an [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/orbits/Orbit.html orbit]<br>
	- an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for forces computation]		- an [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for forces computation] <br>
	- an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for events computation]		- an [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for events computation]<br>
	- a map of additional states (including mass states added from [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider]).		- a map of additional states (including mass states added from [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider]).<br>

	Two attitudes are stored in order to apply (if needed) a different treatment to each attitude.		Two attitudes are stored in order to apply (if needed) a different treatment to each attitude.
Ligne 27 :		Ligne 27 :
	== Features Description ==		== Features Description ==
	=== One orbit ===		=== One orbit ===
	The [{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of one [{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/orbits/Orbit.html Orbit].		The [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of one [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/orbits/Orbit.html Orbit].
	It is possible to simply declare a SpacecraftState with an orbit :		It is possible to simply declare a SpacecraftState with an orbit :
	<code>final SpacecraftState state = new SpacecraftState(orbit);</code>		<code>final SpacecraftState state = new SpacecraftState(orbit);</code>
Ligne 36 :		Ligne 36 :

	=== Two attitudes ===		=== Two attitudes ===
	The user can use one single {{~~JDLink label="Attitude" jd="PS" suffix="~~/fr/cnes/sirius/patrius/attitudes		The user can use one single
	/Attitude.html~~"/}}~~ or two different {{~~JDLink label="Attitude" jd="PS" suffix="~~/fr/cnes/sirius/patrius/attitudes
	/Attitude.html~~"/}}~~ objects : one for forces computation and one for events computation. The following constructor can be used :		[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html Attitude] or two different [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html Attitude] objects : one for forces computation and one for events computation. The following constructor can be used :

	<code>final SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents);</code>		<code>final SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents);</code>
Ligne 70 :		Ligne 70 :

	=== Mass ===		=== Mass ===
	A {{~~JDLink label="MassProvider" jd="PS" suffix="~~fr/cnes/sirius/patrius/propagation		A [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider] can be provided to the SpacecraftState. In that case, the mass information are automaticaly stored as additional states. Be careful, the mass values can never be negative:
	/MassProvider.html~~"/}}~~ can be provided to the SpacecraftState. In that case, the mass information are automaticaly stored as additional states. Be careful, the mass values can never be negative:

	<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit, massProvider);		<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit, massProvider);
Ligne 92 :		Ligne 91 :

	=== State vector ===		=== State vector ===
	The {{~~JDLink label="SpacecraftState" jd="PS" suffix="~~fr/cnes/sirius/patrius/propagation		The [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] object could be created from a state vector :
	/SpacecraftState.html~~"/}}~~ object could be created from a state vector :
	<code>final SpacecraftState state = new SpacecraftState(stateVector, OrbitType.CARTESIAN, PositionAngle.MEAN, date, mu, frame, addStatesInfo, attProviderForces, attProviderEvents);</code>		<code>final SpacecraftState state = new SpacecraftState(stateVector, OrbitType.CARTESIAN, PositionAngle.MEAN, date, mu, frame, addStatesInfo, attProviderForces, attProviderEvents);</code>

Ligne 104 :		Ligne 102 :

	=== Transform ===		=== Transform ===
	The {{~~JDLink label="SpacecraftState" jd="PS" suffix="~~/fr/cnes/sirius/patrius/propagation
	/SpacecraftState.html~~"/}}~~ class contains methods to compute the following transformations :		The [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] class contains methods to compute the following transformations :
	- <code>toTransform()</code> or <code>toTransformForces()</code> : Transform from orbit/attitude reference frame to spacecraft frame (attitude used for forces computation which is the default attitude).		- <code>toTransform()</code> or <code>toTransformForces()</code> : Transform from orbit/attitude reference frame to spacecraft frame (attitude used for forces computation which is the default attitude).<br>
	- <code>toTransformEvents()</code> : Transform from orbit/attitude reference frame to spacecraft frame attitude used for events computation (same as toTransform if there is no specific attitude for Events).		- <code>toTransformEvents()</code> : Transform from orbit/attitude reference frame to spacecraft frame attitude used for events computation (same as toTransform if there is no specific attitude for Events).
	- <code>toTransform(Frame)</code> or <code>toTransformForces(Frame)</code> : Transform from specified [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame (attitude used for forces computation which is the default attitude).		- <code>toTransform(Frame)</code> or <code>toTransformForces(Frame)</code> : Transform from specified [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame (attitude used for forces computation which is the default attitude).<br>
	- <code>toTransformEvents(Frame)</code> : Transform from specified [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame attitude used for events computation (same as toTransform(Frame) if there is no attitude specific for Events).		- <code>toTransformEvents(Frame)</code> : Transform from specified [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame attitude used for events computation (same as toTransform(Frame) if there is no attitude specific for Events).<br>
	- <code>toTransform(LOFType)</code> : Transform from orbit/attitude reference frame to local orbital frame ([{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).		- <code>toTransform(LOFType)</code> : Transform from orbit/attitude reference frame to local orbital frame ([{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).<br>
	- <code>toTransform(Frame, LOFType)</code> : Transform from specified [{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/frames/Frame.html Frame] to local orbital frame ([{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).		- <code>toTransform(Frame, LOFType)</code> : Transform from specified [{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/frames/Frame.html Frame] to local orbital frame ([{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).<br>

	== Getting Started ==		== Getting Started ==
Ligne 147 :		Ligne 145 :
	\|(% colspan="3" %)'''SpacecraftState'''\|(% colspan="6" %)This class is the representation of a complete state holding orbit, attitude for forces and for events computation and additional states at a given date.\|(% colspan="1" %)[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html ...]		\|(% colspan="3" %)'''SpacecraftState'''\|(% colspan="6" %)This class is the representation of a complete state holding orbit, attitude for forces and for events computation and additional states at a given date.\|(% colspan="1" %)[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html ...]
	\|(% colspan="3" %)'''Attitude'''\|(% colspan="6" %)Object representing the attitude of the spacecraft for a specific date and in a specific frame.\|(% colspan="1" %)[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html ...]		\|(% colspan="3" %)'''Attitude'''\|(% colspan="6" %)Object representing the attitude of the spacecraft for a specific date and in a specific frame.\|(% colspan="1" %)[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html ...]

			[[Category:User_Manual_4.0_Flight_Dynamics]]

Admin : Admin a déplacé la page SpacecraftState vers User Manual 4.0 SpacecraftState sans laisser de redirection

2018-02-19T08:42:48Z

Admin a déplacé la page SpacecraftState vers User Manual 4.0 SpacecraftState sans laisser de redirection

← Version précédente	Version du 19 février 2018 à 08:42
(Aucune différence)

Admin : 1 révision importée

2018-02-19T08:41:16Z

1 révision importée

← Version précédente		Version du 19 février 2018 à 08:41
(Aucune différence)

Admin le 19 février 2018 à 08:41

2018-02-19T08:41:15Z

Nouvelle page

== Introduction ==
=== Scope ===
This section describes the SpacecraftState object.

=== Javadoc ===
The object [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is available in the package <code>fr.cnes.sirius.patrius.propagation</code>.

=== Links ===
Here is only described the SpacecraftState structure.
Please refer to [ORB_PRO_Home propagation chapter].

=== Useful Documents ===
None as of now.

=== Overview ===
The [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of :
- an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/orbits/Orbit.html orbit]
- an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for forces computation]
- an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/attitudes/Attitude.html attitude for events computation]
- a map of additional states (including mass states added from [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/propagation/MassProvider.html MassProvider]).

Two attitudes are stored in order to apply (if needed) a different treatment to each attitude.

== Features Description ==
=== One orbit ===
The [{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/propagation/SpacecraftState.html SpacecraftState] is composed of one [{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/orbits/Orbit.html Orbit].
It is possible to simply declare a SpacecraftState with an orbit :
<code>final SpacecraftState state = new SpacecraftState(orbit);</code>

The orbit could be updated using the following method :
<code>final SpacecraftState newState = state.updateOrbit(newOrbit);</code>
The attitude and additional states will remain the same and a new SpacecraftState will be created.

=== Two attitudes ===
The user can use one single {{JDLink label="Attitude" jd="PS" suffix="/fr/cnes/sirius/patrius/attitudes
/Attitude.html"/}} or two different {{JDLink label="Attitude" jd="PS" suffix="/fr/cnes/sirius/patrius/attitudes
/Attitude.html"/}} objects : one for forces computation and one for events computation. The following constructor can be used :

<code>final SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents);</code>

It is possible to get the attitude for forces or events computation using the following methods:

<syntaxhighlight lang="java">final Attitude attForces = state.getAttitudeForces();
final Attitude attEvents = state.getAttitudeEvents();</syntaxhighlight>

The user can deals with a single attitude in the SpacecraftState using the following constructor:
<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit, attitude);
final Attitude att = state.getAttitude();</syntaxhighlight>

If the following constructor is used, both attitudes are set to null value:
<code>final SpacecraftState state = new SpacecraftState(orbit);</code>
Then calling <code>getAttitude</code> or <code>getAttitudeForces</code> or <code>getAttitudeEvents</code> will return null attitude.

=== Additional states ===
The additional states are stored in the SpacecraftState using a Map with the additional states names as keys. The additional states are in the type <code>double[]</code>.
The additional states map could be given directly to the constructor as follow :

<syntaxhighlight lang="java">Map<String, double[]> addStates = new HashMap<String, double[]>();
addStates.put("name", new double[]{1.0});
SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents, addStates); </syntaxhighlight>

It is possible to add an additional state to a SpacecraftState using'''''addAdditionalState''''':

<code>state2 = state.addAdditionalState("name2", new double[]{0.1, 0.1});</code>

Note :'''''addAdditionalState''''' returns a new SpacecraftState with the added additional state. It is necessary to store the returned object. The additional state is not added to the current state.

=== Mass ===
A {{JDLink label="MassProvider" jd="PS" suffix="fr/cnes/sirius/patrius/propagation
/MassProvider.html"/}} can be provided to the SpacecraftState. In that case, the mass information are automaticaly stored as additional states. Be careful, the mass values can never be negative:

<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit, massProvider);
final SpacecraftState state = new SpacecraftState(orbit, attitudeForces, attitudeEvents, massProvider, addStates); </syntaxhighlight>

The mass provider can be added to the SpacecraftState after its initilisation with the method <code>addMassProvider</code> :
<syntaxhighlight lang="java">final SpacecraftState state = new SpacecraftState(orbit);
final SpacecraftState newState = state.addMassProvider(massProvider);</syntaxhighlight>

The mass parts from MassProvider are added to additional states map with the key : "MASS_<partName>".

The total mass of the SpacecraftState could not be obtained.

It is possible to obtain the mass of a given part :
<code>state.getMass("part1"); </code>

and to update the mass of a given part :
<code>state.updateMass("part1", 1000.0); </code>

=== State vector ===
The {{JDLink label="SpacecraftState" jd="PS" suffix="fr/cnes/sirius/patrius/propagation
/SpacecraftState.html"/}} object could be created from a state vector :
<code>final SpacecraftState state = new SpacecraftState(stateVector, OrbitType.CARTESIAN, PositionAngle.MEAN, date, mu, frame, addStatesInfo, attProviderForces, attProviderEvents);</code>

To build the SpacecraftState, it is necessary to know the size and the index of all additional states in the state vector. This information could be obtained from an old state using the following method :
<code>final Map<String, AdditionalStateInfo> addStatesInfos = state.getAdditionalStatesInfos();</code>

The state vector could be obtained from a SpacecraftState :
<syntaxhighlight lang="java">final double[] stateVector = new double[]{};
state.mapStateToArray(OrbitType.CARTESIAN, PositionAngle.MEAN, stateVector); </syntaxhighlight>

=== Transform ===
The {{JDLink label="SpacecraftState" jd="PS" suffix="/fr/cnes/sirius/patrius/propagation
/SpacecraftState.html"/}} class contains methods to compute the following transformations :
- <code>toTransform()</code> or <code>toTransformForces()</code> : Transform from orbit/attitude reference frame to spacecraft frame (attitude used for forces computation which is the default attitude).
- <code>toTransformEvents()</code> : Transform from orbit/attitude reference frame to spacecraft frame attitude used for events computation (same as toTransform if there is no specific attitude for Events).
- <code>toTransform(Frame)</code> or <code>toTransformForces(Frame)</code> : Transform from specified [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame (attitude used for forces computation which is the default attitude).
- <code>toTransformEvents(Frame)</code> : Transform from specified [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/frames/Frame.html Frame] to spacecraft frame attitude used for events computation (same as toTransform(Frame) if there is no attitude specific for Events).
- <code>toTransform(LOFType)</code> : Transform from orbit/attitude reference frame to local orbital frame ([{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).
- <code>toTransform(Frame, LOFType)</code> : Transform from specified [{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/frames/Frame.html Frame] to local orbital frame ([{{PathCurrentJavaDoc}}''fr/cnes/sirius/patrius/frames/LOFType.html LOFType]).

== Getting Started ==

=== Using Transform ===

Here after is presented the computation of a station position in spacecraft frame:
<syntaxhighlight lang="java">
// Station position defined in GCRF
final Vector3D station_InGCRF = new Vector3D(Constants.EGM96_EARTH_EQUATORIAL_RADIUS, 0, 0);
final Frame gcrf = FramesFactory.getGCRF();
// Compute transform from GCRF to spacecraft frame
final Transform transform = state.toTransform(gcrf);
// Station position in spacecraft frame
final Vector3D station_InSpacecraftFrame = transform.transformVector(station_InGCRF);
</syntaxhighlight>

Here after is presented the computation of the Sun direction in spacecraft frame.
<syntaxhighlight lang="java">
// Compute transform from orbit/attitude reference frame to local orbital frame TNW
final Transform transform = state.toTransform(LOFType.TNW);
// Position of Sun in local orbital frame TNW
final Vector3D pos = transform.transformPosition(sun.getPVCoordinates().getPosition());
</syntaxhighlight>
If an [{{PathCurrentJavaDoc}}//fr/cnes/sirius/patrius/assembly/Assembly.html Assembly] is used, this is not necessary to use these methods because the conversion methods are included in Assembly functionalities (see [SPC_VBU_Home dedicated User Manual]).

== Contents ==
=== Interfaces ===
|=(% colspan="3" %)Interface|=(% colspan="6" %)Summary|=(% colspan="1" %)Javadoc
|(% colspan="3" %)'''MassProvider'''|(% colspan="6" %)Interface providing the mass for spacecraft models.|[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/MassProvider.html ...]

=== Classes ===

|=(% colspan="3" %)Class|=(% colspan="6" %)Summary|=(% colspan="1" %)Javadoc
|(% colspan="3" %)'''SpacecraftState'''|(% colspan="6" %)This class is the representation of a complete state holding orbit, attitude for forces and for events computation and additional states at a given date.|(% colspan="1" %)[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/propagation/SpacecraftState.html ...]
|(% colspan="3" %)'''Attitude'''|(% colspan="6" %)Object representing the attitude of the spacecraft for a specific date and in a specific frame.|(% colspan="1" %)[{{PathCurrentJavaDoc}}/fr/cnes/sirius/patrius/attitudes/Attitude.html ...]

User Manual 4.0 SpacecraftState - Historique des versions

Admin le 21 février 2018 à 14:00

Admin : /* Classes */

Admin : /* Interfaces */