User Manual 4.3 Orientation : Différence entre versions

De Wiki
Aller à : navigation, rechercher
(Page créée avec « Category:User_Manual_4.3_Attitude »)
 
 
Ligne 1 : Ligne 1 :
 +
__NOTOC__
 +
== Introduction ==
 +
=== Scope ===
 +
The purpose of this chapter is to describe the orientation package.
 +
 +
An orientation provider is an interface that provides methods to return an angle as a function of a spacecraft state.
 +
 +
=== Javadoc ===
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Library
 +
! scope="col"| Javadoc
 +
|-
 +
|Patrius
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/orientations/package-summary.html Package fr.cnes.sirius.patrius.attitudes.orientations]
 +
|}
 +
 +
=== Links ===
 +
None as of now.
 +
 +
=== Useful Documents ===
 +
None as of now.
 +
 +
=== Package Overview ===
 +
 +
== Features Description ==
 +
The orientations package is designed similarly to attitude providers:
 +
* An interface <code>OrientationAngleProvider</code> returns an angle given a spacecraft state (similarly to  <code>AttitudeProvider</code> which returns an Attitude)
 +
* An interface <code>OrientationAngleLaw</code> gathers orientation laws and is similar to <code>AttitudeLaw</code>
 +
* An interface <code>OrientationAngleLeg</code> is a time-bounded leg and is similar to <code>AttitudeLeg</code>
 +
* An interface <code>OrientationAngleProfile</code> is a profile of orientation angles and is similar to <code>AttitudeProfile</code>
 +
* A class <code>OrientationAngleLawLeg</code> is a law leg and is similar to <code>AttitudeLawLeg</code>
 +
* A class <code>OrientationAngleLawLegsSequence</code> is a sequence of <code>OrientationAngleLawLeg</code> and is similar to <code>AttitudeLawLegsSequence</code>
 +
* A class <code>OrientationAngleProfileSequence</code> is a sequence of <code>OrientationAngleProfile</code> and is similar to <code>AttitudeProfileSequence</code>
 +
 +
Note: the package currently does not provide any implementation of <code>OrientationAngleProvider</code> interface except for constant angles.
 +
 +
== Getting Started ==
 +
Use is identical to attitudes. See the [[Catégorie:User Manual 4.3 Attitude|Attitude]] page for examples.
 +
 +
== Contents ==
 +
=== Interfaces ===
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Interface
 +
! scope="col"| Summary
 +
! scope="col"| Javadoc
 +
|-
 +
|'''OrientationAngleProvider'''
 +
|Interface for all orientation angles providers.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/orientations/OrientationAngleProvider.html ...]
 +
|-
 +
|'''OrientationAngleLaw'''
 +
|Interface for all orientation angles lasw.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/orientations/OrientationAngleLaw.html ...]
 +
|-
 +
|'''OrientationAngleLeg'''
 +
|Interface for all orientation angles legs.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/orientations/OrientationAngleLeg.html ...]
 +
|-
 +
|'''OrientationAngleProfile'''
 +
|Interface for all orientation angles profiles.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/orientations/OrientationAngleProfile.html ...]
 +
|}
 +
 +
=== Classes ===
 +
{| class="wikitable"
 +
|-
 +
! scope="col"| Class
 +
! scope="col"| Summary
 +
! scope="col"| Javadoc
 +
|-
 +
|'''OrientationAngleLawLeg'''
 +
|Orientation angle law leg.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/OrientationAngleLawLeg.html ...]
 +
|-
 +
|'''OrientationAngleLawLegsSequence'''
 +
|Sequence of Orientation angle legs.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/OrientationAngleLawLegsSequence.html ...]
 +
|-
 +
|'''OrientationAngleProfileSequence'''
 +
|Sequence of Orientation angle profiles.
 +
|[{{JavaDoc4.3}}/fr/cnes/sirius/patrius/attitudes/OrientationAngleProfileSequence.html ...]
 +
|}
 +
 
[[Category:User_Manual_4.3_Attitude]]
 
[[Category:User_Manual_4.3_Attitude]]

Version actuelle en date du 3 juin 2019 à 14:42

Introduction

Scope

The purpose of this chapter is to describe the orientation package.

An orientation provider is an interface that provides methods to return an angle as a function of a spacecraft state.

Javadoc

Library Javadoc
Patrius Package fr.cnes.sirius.patrius.attitudes.orientations

Links

None as of now.

Useful Documents

None as of now.

Package Overview

Features Description

The orientations package is designed similarly to attitude providers:

  • An interface OrientationAngleProvider returns an angle given a spacecraft state (similarly to AttitudeProvider which returns an Attitude)
  • An interface OrientationAngleLaw gathers orientation laws and is similar to AttitudeLaw
  • An interface OrientationAngleLeg is a time-bounded leg and is similar to AttitudeLeg
  • An interface OrientationAngleProfile is a profile of orientation angles and is similar to AttitudeProfile
  • A class OrientationAngleLawLeg is a law leg and is similar to AttitudeLawLeg
  • A class OrientationAngleLawLegsSequence is a sequence of OrientationAngleLawLeg and is similar to AttitudeLawLegsSequence
  • A class OrientationAngleProfileSequence is a sequence of OrientationAngleProfile and is similar to AttitudeProfileSequence

Note: the package currently does not provide any implementation of OrientationAngleProvider interface except for constant angles.

Getting Started

Use is identical to attitudes. See the page for examples.

Contents

Interfaces

Interface Summary Javadoc
OrientationAngleProvider Interface for all orientation angles providers. ...
OrientationAngleLaw Interface for all orientation angles lasw. ...
OrientationAngleLeg Interface for all orientation angles legs. ...
OrientationAngleProfile Interface for all orientation angles profiles. ...

Classes

Class Summary Javadoc
OrientationAngleLawLeg Orientation angle law leg. ...
OrientationAngleLawLegsSequence Sequence of Orientation angle legs. ...
OrientationAngleProfileSequence Sequence of Orientation angle profiles. ...
Récupérée de « http://patrius.cnes.fr/index.php?title=User_Manual_4.3_Orientation&oldid=2339 »