fr.cnes.genopus.orbits

Class GPApsisRadiusParameters

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.orbits.GPParametersAbstract

fr.cnes.genopus.orbits.GPParametersAbstractWithAnomaly

fr.cnes.genopus.orbits.GPApsisRadiusParameters

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>

public class GPApsisRadiusParameters
extends GPParametersAbstractWithAnomaly

Widget representing the apsis radius parameters of an object (rp, ra, i, pa, raan, anomaly) in a gravitational field, mu. Anomaly can be represented as mean, eccentric or true.

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	entryRealRp	1, 0, 0 => "newline , gapleft 30 , split 2" 1, 0, 1 => (null) 1, 1 => "alignx Right" 1, 2 => (null)
2	GEntryReal	entryRealRa	2, 0, 0 => "newline , gapleft 30 , split 2" 2, 0, 1 => (null) 2, 1 => "alignx Right" 2, 2 => (null)
3	GEntryReal	entryRealI	3, 0, 0 => "newline , gapleft 30 , split 2" 3, 0, 1 => (null) 3, 1 => "alignx Right" 3, 2 => (null)
4	GEntryReal	entryRealRAAN	4, 0, 0 => "newline , gapleft 30 , split 2" 4, 0, 1 => (null) 4, 1 => "alignx Right" 4, 2 => (null)
5	GEntryReal	entryRealPA	5, 0, 0 => "newline , gapleft 30 , split 2" 5, 0, 1 => (null) 5, 1 => "alignx Right" 5, 2 => (null)
6	GEntryReal	entryRealAnomaly	6, 0, 0 => (null) 6, 0, 1 => (null) 6, 1 => "alignx Right" 6, 2 => (null)
7	GPEntryEarthMu	entryRealMu	"newline" (see table below)
8	GPopupListWithLabel	popupListVType	8, 0, 0 => "newline , gapleft 30 , split 2" 8, 0, 1 => (null) 8, 1 => "split 4 , alignx Right"
9	GButton	forcePivotButton	(null)

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
protected void	aditionalActionsAfter2(fr.cnes.genius.main.GEvent e) Additional actions to be performed by the after() method of class GPParametersAbstractWithAnomaly, 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 fr.cnes.genius.highLevel.GEntryReal	getAnomalyEntryReal() Generic getter for the GEntryReal corresponding to the anomaly/longitude/AoL.
protected double	getCurrentAnomalyValue() Getter for the current value of the anomaly/longitude/AoL.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealI() Getter for the GEntryReal defining the inclination.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealPA() Getter for the GEntryReal defining the perigee argument.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealRa() Getter for the GEntryReal defining the apogee geocentric radius.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealRAAN() Getter for the GEntryReal defining the right ascension of the ascending node.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealRp() Getter for the GEntryReal defining the perigee geocentric radius.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealV() Getter for the GEntryReal defining the anomaly.
fr.cnes.genius.highLevel.GPopupListWithLabel	getGPopupList() Generic getter for the GPopupListWithLabel corresponding to the anomaly/longitude/AoL type selector (true, mean ou eccentric).
fr.cnes.sirius.patrius.orbits.orbitalparameters.IOrbitalParameters	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.orbits.PositionAngle	getTypeOfAnomaly() Getter for the type of anomaly angle (TRUE, MEAN or ECCENTRIC).
protected fr.cnes.genius.main.GItemTypeInterface	getXMLType() Generic getter for the set of orbital parameters item type in the XML configuration file.
void	read()
protected void	recomputeAnomaliesMap() Recomputes the three types of anomaly/longitude/AoL by creating an auxiliary orbit.
void	setParams(double[] params, fr.cnes.sirius.patrius.orbits.PositionAngle anomalyType) Setter for the widget parameters.

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

aditionalActionsAfter1, clear, display, generic, getCurrentAnomalyType, getParams, getPivotAnomalyType, getSubComponent, isButtonForcePivotVisible, isInPivot, isModified, onButtonForcePivot, onGEntryRealParams, recomputePivot, setAnomalies, setButtonForcePivotVisible, setConstraint, setCurrentAnomalyType, setDefaultParams, setDefaultParams, setDefaultParams, setDefaultParams, setDisplayIsModifiedIndicatorAll, setEnabled, setParams, setParams, setParams, setSavedParams, setSavedParams, setSavedParams, setSavedParams, updateIsModifiedIndicator, updateIsPivotButtonEnabled, updateStatus, write

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

after, attachCopyPasteMenu, before, copyNullParams, getGEntryRealMu, getGLabel, getName, getParametersGEntryRealsList, handleOrbitCopyPasteEvent, isBlockedConversions, isEnabled, isParamsNull, modMinusPiPlusPi, setBlockedConversions, setDefaultConstraint, updateCondensedStatus

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

GPApsisRadiusParameters

public GPApsisRadiusParameters(String label)

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

Parameters:

label - text to display in the label.

GPApsisRadiusParameters

public GPApsisRadiusParameters(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 apsis parameters in the given frame.

GPApsisRadiusParameters

public GPApsisRadiusParameters(String widgetId,
                       String label)

Constructor without apsis 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.

GPApsisRadiusParameters

public GPApsisRadiusParameters(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 apsis parameters in the given frame.

Method Detail

getGEntryRealRp

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

Getter for the GEntryReal defining the perigee geocentric radius.

Returns:

the GEntryReal defining the perigee geocentric radius.

getGEntryRealRa

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

Getter for the GEntryReal defining the apogee geocentric radius.

Returns:

the GEntryReal defining the apogee geocentric radius.

getGEntryRealI

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

Getter for the GEntryReal defining the inclination.

Returns:

the GEntryReal defining the inclination.

getGEntryRealRAAN

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

Getter for the GEntryReal defining the right ascension of the ascending node.

Returns:

the GEntryReal defining the right ascension of the ascending node.

getGEntryRealPA

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

Getter for the GEntryReal defining the perigee argument.

Returns:

the GEntryReal defining the perigee argument.

getGEntryRealV

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

Getter for the GEntryReal defining the anomaly.

Returns:

the GEntryReal defining the anomaly.

getGPopupList

public fr.cnes.genius.highLevel.GPopupListWithLabel getGPopupList()

Generic getter for the GPopupListWithLabel corresponding to the anomaly/longitude/AoL type selector (true, mean ou eccentric).

Specified by:

getGPopupList in class GPParametersAbstractWithAnomaly

Returns:

the GPopupListWithLabel for the anomaly/longitude/AoL type selector (true, mean ou eccentric).

getTypeOfAnomaly

public fr.cnes.sirius.patrius.orbits.PositionAngle getTypeOfAnomaly()

Getter for the type of anomaly angle (TRUE, MEAN or ECCENTRIC).

Returns:

the type of anomaly angle (TRUE, MEAN or ECCENTRIC)

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.

getPatriusObject

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

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.

Throws:

GPOrbitException - if the parameters cannot be created

recomputeAnomaliesMap

protected void recomputeAnomaliesMap()
                              throws GPOrbitException

Recomputes the three types of anomaly/longitude/AoL by creating an auxiliary orbit.

Specified by:

recomputeAnomaliesMap in class GPParametersAbstractWithAnomaly

Throws:

GPOrbitException - if the current orbital parameters (with pivot anomaly/longitude/AoL) do not represent a valid orbit.

getAnomalyEntryReal

protected fr.cnes.genius.highLevel.GEntryReal getAnomalyEntryReal()

Generic getter for the GEntryReal corresponding to the anomaly/longitude/AoL.

Specified by:

getAnomalyEntryReal in class GPParametersAbstractWithAnomaly

Returns:

the anomaly/longitude/AoL GEntryReal

getCurrentAnomalyValue

protected double getCurrentAnomalyValue()

Getter for the current value of the anomaly/longitude/AoL.

Specified by:

getCurrentAnomalyValue in class GPParametersAbstractWithAnomaly

Returns:

the current value of the anomaly/longitude/AoL.

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.

aditionalActionsBefore1

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.

Specified by:

aditionalActionsBefore1 in class GPParametersAbstract

Parameters:

e - processed event

aditionalActionsAfter2

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

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

Specified by:

aditionalActionsAfter2 in class GPParametersAbstractWithAnomaly

Parameters:

e - processed event

Throws:

GPOrbitException - in case of any problem

setParams

public void setParams(double[] params,
             fr.cnes.sirius.patrius.orbits.PositionAngle anomalyType)
               throws GPOrbitException,
                      fr.cnes.genius.exception.GArithmeticException

Setter for the widget parameters.

Overrides:

setParams in class GPParametersAbstractWithAnomaly

Parameters:

params - the array of parameters to be set.

anomalyType - the type of anomaly/longitude/AoL (TRUE, MEAN or ECCENTRIC) to be set

Throws:

GPOrbitException - if the given orbital parameters do not represent a valid orbit.

fr.cnes.genius.exception.GArithmeticException - if any of the params is NaN.

read

public void read()
          throws fr.cnes.genius.exception.GException

Specified by:

read in interface fr.cnes.genius.main.GReadWrite

Overrides:

read in class GPParametersAbstractWithAnomaly

Throws:

fr.cnes.genius.exception.GException