fr.cnes.genopus.orbits

Class GPReentryParameters

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.orbits.GPParametersAbstract

fr.cnes.genopus.orbits.GPReentryParameters

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters>, GPCentralBodyFlatness, GPCentralBodyRadius

public class GPReentryParameters
extends GPParametersAbstract
implements GPCentralBodyRadius, GPCentralBodyFlatness

Widget representing the Reentry parameters of an object (alt, lat, lon, vel, fpa, azi) in a gravitational field, mu, in a central body with equatorial radius, req and flatness flat.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0 , spanx 2 , split 2" 0, 1 => (null)
1	GEntryReal	entryRealAlt	1, 0, 0 => "newline , gapleft 30 , split 2" 1, 0, 1 => (null) 1, 1 => "alignx Right" 1, 2 => (null)
2	GEntryReal	entryRealLat	2, 0, 0 => "newline , gapleft 30 , split 2" 2, 0, 1 => (null) 2, 1 => "alignx Right" 2, 2 => (null)
3	GEntryReal	entryRealLon	3, 0, 0 => "newline , gapleft 30 , split 2" 3, 0, 1 => (null) 3, 1 => "alignx Right" 3, 2 => (null)
4	GEntryReal	entryRealVel	4, 0, 0 => "newline , gapleft 30 , split 2" 4, 0, 1 => (null) 4, 1 => "alignx Right" 4, 2 => (null)
5	GEntryReal	entryRealFpa	5, 0, 0 => "newline , gapleft 30 , split 2" 5, 0, 1 => (null) 5, 1 => "alignx Right" 5, 2 => (null)
6	GEntryReal	entryRealAzi	6, 0, 0 => "newline , gapleft 30 , split 2" 6, 0, 1 => (null) 6, 1 => "alignx Right" 6, 2 => (null)
7	GPEntryEarthMu	entryRealMu	"newline" (see table below)

Default Constraint(s) for entryRealMu:

Index	Class	Item	Constraint
7, 0	GLabelWithIndicator	label	7, 0, 0 => "newline , gapleft 30 , split 2" 7, 0, 1 => (null)
7, 1	GRealField	textField	(null)
7, 2	GPopupList	units	(null)
7, 3	GConstantSelector	constantSelector	"newline" (see table below)

Default Constraint(s) for constantSelector:

Index	Class	Item	Constraint
7, 3, 0	GButton	button	"split 2 , alignx Right"
7, 3, 1	GConstantSelelectorDialog	dialog	"newline , pushx , pushy , growx , growy" (see table below)

Default Constraint(s) for dialog:

Index	Class	Item	Constraint
7, 3, 1, 0	GComboBoxWithLabel	combobox	7, 3, 1, 0, 0, 0 => "split 3" 7, 3, 1, 0, 0, 1 => (null) 7, 3, 1, 0, 1 => (null)
7, 3, 1, 1	GLabel	label	"newline , split 3"
7, 3, 1, 2	GLabel	valueLabel	(null)
7, 3, 1, 3	GLabel	unitLabel	(null)
7, 3, 1, 4	GButton	selectButton	"newline , pushx , pushy"
7, 3, 1, 5	GButton	cancelButton	(null)

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.main.GComponent

fr.cnes.genius.main.GComponent.CopyPasteOperation, fr.cnes.genius.main.GComponent.DisplayIndicatorStatus, fr.cnes.genius.main.GComponent.ItemType, fr.cnes.genius.main.GComponent.Operation

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID Identifier for the set of orbital parameters.

Fields inherited from class fr.cnes.genopus.orbits.GPParametersAbstract

ANGLE_UNITS, DISTANCE_UNITS, INT_ERR_MNS_2_TO_2, INT_ERR_MNS_INF_TO_ZERO, INT_ERR_MNS_ONE_TO_ONE_EXC, INT_ERR_MNS_ONE_TO_ONE_INC, INT_ERR_ZERO_EX_TO_INF, INT_ERR_ZERO_IN_TO_INF, INT_WARN_MNS_PI_TO_PI, INT_WARN_ZERO_TO_PI, NULL_PARAMS, VELOCITY_UNITS

Fields inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Fields inherited from interface fr.cnes.genopus.orbits.GPCentralBodyRadius

DEFAULT_EARTH_EQ_RADIUS

Fields inherited from interface fr.cnes.genopus.orbits.GPCentralBodyFlatness

DEFAULT_EARTH_FLATNESS

Constructor Summary

Constructors

Constructor and Description
GPReentryParameters(String label) Constructor without Reentry parameters (they will be initialized to zero).
GPReentryParameters(String label, fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters params) Constructor.
GPReentryParameters(String widgetId, String label) Constructor without Reentry parameters (they will be initialized to zero).
GPReentryParameters(String widgetId, String label, fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters params) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	aditionalActionsAfter1(fr.cnes.genius.main.GEvent e) Additional actions to be performed by the after() method of class GPParametersAbstract, to be implemented by its sub-classes.
protected void	aditionalActionsBefore1(fr.cnes.genius.main.GEvent e) Additional actions to be performed by the before() method of class GPParametersAbstract, to be implemented by its sub-classes.
protected fr.cnes.genius.interval.GIntervalAbstract.GStatus	checkGlobalCoherence(fr.cnes.genius.interval.GIntervalAbstract.GStatus status) Checks if the the global coherence conditions are fulfilled by the parameters.
protected double[]	computeParamsArray(fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters params) Computes the orbital parameters array in the same order as shown in the widget .
protected double[]	copyNullParams() Initialize the array of orbital parameters to the null parameters defined by GPReentryParameters#NULL_REENTRY_PARAMS.
double	getCentralBodyEqRadius() Getter for the central body equatorial radius from the widget.
double	getCentralBodyFlatness() Getter for the central body flatness from the widget.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealAlt() Getter for the GEntryReal defining the geodetic altitude.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealAzi() Getter for the GEntryReal defining the geodetic azimuth of the velocity vector wrt.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealFlat() Getter for the GEntryReal defining the flatness of the central body.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealFpa() Getter for the GEntryReal defining the geodetic gradient of the velocity vector.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealLat() Getter for the GEntryReal defining the latitude.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealLon() Getter for the GEntryReal defining the longitude.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealReq() Getter for the GEntryReal defining the equatorial radius of the central body.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealVel() Getter for the GEntryReal defining the velocity norm.
fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
protected fr.cnes.genius.main.GItemTypeInterface	getXMLType() Generic getter for the set of orbital parameters item type in the XML configuration file.
void	recomputeParams() Method to recalculate the orbital parameters when the central body equatorial radius has changed.
void	setCentralBodyEqRadius(double centralBodyEqRadius) Setter for the central body equatorial radius in the widget.
void	setCentralBodyFlatness(double centralBodyFlatness) Setter for the central body flatness in the widget.
void	setConstraint(int labelGap, int paramsGap) Setter for the constraints of the orbital parameters.

Methods inherited from class fr.cnes.genopus.orbits.GPParametersAbstract

after, attachCopyPasteMenu, before, clear, display, generic, getGEntryRealMu, getGLabel, getName, getParametersGEntryRealsList, getParams, handleOrbitCopyPasteEvent, isBlockedConversions, isEnabled, isModified, isParamsNull, modMinusPiPlusPi, onGEntryRealParams, read, setBlockedConversions, setDefaultConstraint, setDefaultParams, setDefaultParams, setDisplayIsModifiedIndicatorAll, setEnabled, setParams, setParams, setSavedParams, setSavedParams, updateCondensedStatus, updateIsModifiedIndicator, updateStatus, write

Methods inherited from class fr.cnes.genius.lowLevel.GContainer

put

Methods inherited from class fr.cnes.genius.main.GComponent

activateConstraintsByType, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDefaultConstraints, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setNameAndCommentInConfigFile, setNameInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidgetId, setWidth, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final int ID

Identifier for the set of orbital parameters.

See Also:

Constant Field Values

Constructor Detail

GPReentryParameters

public GPReentryParameters(String label)

Constructor without Reentry parameters (they will be initialized to zero). The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

GPReentryParameters

public GPReentryParameters(String label,
                   fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters params)
                    throws GPOrbitException

Constructor. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

params - orbital parameters to set.

Throws:

GPOrbitException - if if given orbit cannot be represented in reentry parameters in the given frame.

GPReentryParameters

public GPReentryParameters(String widgetId,
                   String label)

Constructor without Reentry parameters (they will be initialized to zero).

Parameters:

widgetId - widget identifier, if null an identifier will be automatically created.

label - text to display in the label.

GPReentryParameters

public GPReentryParameters(String widgetId,
                   String label,
                   fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters params)
                    throws GPOrbitException

Constructor.

Parameters:

widgetId - widget identifier, if null an identifier will be automatically created.

label - text to display in the label.

params - orbital parameters to set.

Throws:

GPOrbitException - if if given orbit cannot be represented in reentry parameters in the given frame.

Method Detail

getGEntryRealAlt

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealAlt()

Getter for the GEntryReal defining the geodetic altitude. To get the geocentric value, set the central body flatness to 0.

Returns:

the GEntryReal defining the geodetic altitude.

getGEntryRealLat

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealLat()

Getter for the GEntryReal defining the latitude.

Returns:

the GEntryReal defining the latitude.

getGEntryRealLon

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealLon()

Getter for the GEntryReal defining the longitude.

Returns:

the GEntryReal defining the longitude.

getGEntryRealVel

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealVel()

Getter for the GEntryReal defining the velocity norm.

Returns:

the GEntryReal defining the velocity norm.

getGEntryRealFpa

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealFpa()

Getter for the GEntryReal defining the geodetic gradient of the velocity vector. To get the geocentric value, set the central body flatness to 0.

Returns:

the GEntryReal defining the geodetic gradient of the velocity vector.

getGEntryRealAzi

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealAzi()

Getter for the GEntryReal defining the geodetic azimuth of the velocity vector wrt. North. To get the geocentric value, set the central body flatness to 0.

Returns:

the GEntryReal defining the geodetic azimuth of the velocity vector wrt. North.

getGEntryRealReq

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealReq()

Getter for the GEntryReal defining the equatorial radius of the central body.

Returns:

the GEntryReal defining the equatorial radius of the central body.

getGEntryRealFlat

public fr.cnes.genius.highLevel.GEntryReal getGEntryRealFlat()

Getter for the GEntryReal defining the flatness of the central body.

Returns:

the GEntryReal defining the flatness of the central body.

setConstraint

public void setConstraint(int labelGap,
                 int paramsGap)

Setter for the constraints of the orbital parameters.

Overrides:

setConstraint in class GPParametersAbstract

Parameters:

labelGap - left gap from panel border to display the label of the orbital parameters

paramsGap - left gap from panel border to display the orbital parameters

computeParamsArray

protected double[] computeParamsArray(fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters params)
                               throws GPOrbitException,
                                      fr.cnes.genius.exception.GArithmeticException

Computes the orbital parameters array in the same order as shown in the widget .

Specified by:

computeParamsArray in class GPParametersAbstract

Parameters:

params - the orbital parameters as a IOrbitalParameters patrius object.

Returns:

the array of orbital parameters.

Throws:

GPOrbitException - if the params are invalid:
- cartesian: if x=y=z=0, or if vx=vy=vz=0, or if pos and vel are parallel, or if Mu<0.
- keplerian: if a>=0 & e>1, or if a<0 & e<1, or if Mu<0.
- circular: if ex>1, or ey>1, or ex*ex+ey*ey>1, or a<0, or Mu<0
- equatorial: if e>1, or ix>2, or iy>2, or ix*ix+iy*iy>2, or a<0, or Mu<0
- equinoctial: if ex>1, or ey>1, or ex*ex+ey*ey>1, or hx*hx+hy*hy>1, or a<1, or Mu<0
- apsis: if ra>=rp & rp<0, or ra0, or if Mu<0

fr.cnes.genius.exception.GArithmeticException - if the params are invalid:
- cartesian: if x, y z, vx, vy, vz or Mu are NaN.
- keplerian: if raan, pa, i, a, e, v or Mu are NaN.
- circular: if a, ex, ey, i, raan, alphaV or Mu are NaN.
- equatorial: if a, e, ix, iy, pomega, v or Mu are NaN.
- equinoctial: if a, ex, ey, hx, hy, lv or Mu are NaN.
- apsis: if ra, rp, i, raan, pa, v or Mu are NaN.
- reentry: if alt, lat, lon, vel, fpa, azi, ae, f or Mu are NaN

checkGlobalCoherence

protected fr.cnes.genius.interval.GIntervalAbstract.GStatus checkGlobalCoherence(fr.cnes.genius.interval.GIntervalAbstract.GStatus status)

Checks if the the global coherence conditions are fulfilled by the parameters.

Specified by:

checkGlobalCoherence in class GPParametersAbstract

Parameters:

status - initial status.

Returns:

status after checking global coherence of the parameters.

getXMLType

protected fr.cnes.genius.main.GItemTypeInterface getXMLType()

Generic getter for the set of orbital parameters item type in the XML configuration file.

Specified by:

getXMLType in class GPParametersAbstract

Returns:

the parameters XML item type.

aditionalActionsAfter1

protected void aditionalActionsAfter1(fr.cnes.genius.main.GEvent e)
                               throws GPOrbitException

Additional actions to be performed by the after() method of class GPParametersAbstract, to be implemented by its sub-classes.

Specified by:

aditionalActionsAfter1 in class GPParametersAbstract

Parameters:

e - processed event

Throws:

GPOrbitException - in case of any problem

aditionalActionsBefore1

protected void aditionalActionsBefore1(fr.cnes.genius.main.GEvent e)
                                throws GPOrbitException

Additional actions to be performed by the before() method of class GPParametersAbstract, to be implemented by its sub-classes.

Specified by:

aditionalActionsBefore1 in class GPParametersAbstract

Parameters:

e - processed event

Throws:

GPOrbitException

copyNullParams

protected double[] copyNullParams()

Initialize the array of orbital parameters to the null parameters defined by GPReentryParameters#NULL_REENTRY_PARAMS.

Overrides:

copyNullParams in class GPParametersAbstract

Returns:

an array of null orbital parameters.

getPatriusObject

public fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters getPatriusObject()

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters>

Specified by:

getPatriusObject in class GPParametersAbstract

Returns:

the PATRIUS object associated to the widget.

getCentralBodyEqRadius

public double getCentralBodyEqRadius()

Getter for the central body equatorial radius from the widget.

Specified by:

getCentralBodyEqRadius in interface GPCentralBodyRadius

Returns:

the central body equatorial radius obtained from the widget.

setCentralBodyEqRadius

public void setCentralBodyEqRadius(double centralBodyEqRadius)
                            throws fr.cnes.genius.exception.GArithmeticException

Setter for the central body equatorial radius in the widget.

Specified by:

setCentralBodyEqRadius in interface GPCentralBodyRadius

Parameters:

centralBodyEqRadius - the central body equatorial radius to be set to the widget.

Throws:

fr.cnes.genius.exception.GArithmeticException - if centralBodyEqRadius is NaN.

getCentralBodyFlatness

public double getCentralBodyFlatness()

Getter for the central body flatness from the widget.

Specified by:

getCentralBodyFlatness in interface GPCentralBodyFlatness

Returns:

the central body flatness obtained from the widget.

setCentralBodyFlatness

public void setCentralBodyFlatness(double centralBodyFlatness)
                            throws fr.cnes.genius.exception.GArithmeticException

Setter for the central body flatness in the widget.

Specified by:

setCentralBodyFlatness in interface GPCentralBodyFlatness

Parameters:

centralBodyFlatness - the central body flatness to be set to the widget.

Throws:

fr.cnes.genius.exception.GArithmeticException - if centralBodyFlatness is NaN.

recomputeParams

public void recomputeParams()
                     throws GPOrbitException

Method to recalculate the orbital parameters when the central body equatorial radius has changed.

Specified by:

recomputeParams in interface GPCentralBodyFlatness

Specified by:

recomputeParams in interface GPCentralBodyRadius

Throws:

GPOrbitException - in case of problem when recalculating the parameters.

getSubComponent

public fr.cnes.genius.main.GComponent getSubComponent(int position)
                                               throws fr.cnes.genius.exception.GComponentException

Overrides:

getSubComponent in class GPParametersAbstract

Throws:

fr.cnes.genius.exception.GComponentException