fr.cnes.genopus.orbits
Class GPApsisAltitudeParameters

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.GPApsisAltitudeParameters

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<org.orekit.orbits.orbitalparameters.IOrbitalParameters>, GPCentralBodyRadius

public class GPApsisAltitudeParameters
extends GPParametersAbstractWithAnomaly
implements GPCentralBodyRadius

Widget representing the apsis altitude parameters of an object (hp, ha, i, pa, raan, anomaly) in a gravitational field, mu, and with an Earth equatorial radius, req. 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	entryRealHp	1, 0, 0 => "newline , gapleft 30 , split 2" 1, 0, 1 => (null) 1, 1 => "alignx Right" 1, 2 => (null)
2	GEntryReal	entryRealHa	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)
10	GPEntryEarthEqRad	entryRealReq	"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)

Default Constraint(s) for entryRealReq:

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

Default Constraint(s) for constantSelector:

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

Default Constraint(s) for dialog:

Index	Class	Item	Constraint
10, 3, 1, 0	GComboBoxWithLabel	combobox	10, 3, 1, 0, 0, 0 => "split 3" 10, 3, 1, 0, 0, 1 => (null) 10, 3, 1, 0, 1 => (null)
10, 3, 1, 1	GLabel	label	"newline , split 3"
10, 3, 1, 2	GLabel	valueLabel	(null)
10, 3, 1, 3	GLabel	unitLabel	(null)
10, 3, 1, 4	GButton	selectButton	"newline , pushx , pushy"
10, 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

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_INF_TO_ZERO, INT_ERR_MNS_ONE_TO_ONE_EXC, INT_ERR_MNS_ONE_TO_ONE_INC, INT_ERR_MNS_SQRT_2_TO_SQRT_2, 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

Constructor Summary

GPApsisAltitudeParameters(String label)
Constructor without apsis parameters (they will be initialized to zero).

GPApsisAltitudeParameters(String label, org.orekit.orbits.orbitalparameters.IOrbitalParameters params)
Constructor.

GPApsisAltitudeParameters(String widgetId, String label)
Constructor without apsis parameters (they will be initialized to zero).

GPApsisAltitudeParameters(String widgetId, String label, org.orekit.orbits.orbitalparameters.IOrbitalParameters params)
Constructor.

Method Summary

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(org.orekit.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 GPApsisAltitudeParameters#NULL_APSIS_PARAMS.
void	display()
protected fr.cnes.genius.highLevel.GEntryReal	getAnomalyEntryReal() Generic getter for the GEntryReal corresponding to the anomaly/longitude/AoL.
double	getCentralBodyEqRadius() Getter for the central body equatorial radius from the widget.
protected double	getCurrentAnomalyValue() Getter for the current value of the anomaly/longitude/AoL.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealHa() Getter for the GEntryReal defining the apogee geocentric altitude.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealHp() Getter for the GEntryReal defining the perigee geocentric altitude.
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	getGEntryRealRAAN() Getter for the GEntryReal defining the right ascension of the ascending node.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealReq() Getter for the GEntryReal defining the equatorial radius of the central body.
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).
org.orekit.orbits.orbitalparameters.IOrbitalParameters	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
org.orekit.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.
protected void	recomputeAnomaliesMap() Recomputes the three types of anomaly/longitude/AoL by creating an auxiliary orbit.
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	setConstraint(int labelGap, int paramsGap) Setter for the constraints of the orbital parameters.
void	setEnabled(boolean b)

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

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

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

after, attachCopyPasteMenu, before, getGEntryRealMu, getGLabel, getName, getParametersGEntryRealsList, handleOrbitCopyPasteEvent, isBlockedConversions, isEnabled, isParamsNull, 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, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getNameInConfigFile, getOperationSaveValue, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, 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

GPApsisAltitudeParameters

public GPApsisAltitudeParameters(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.

GPApsisAltitudeParameters

public GPApsisAltitudeParameters(String label,
                                 org.orekit.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.

GPApsisAltitudeParameters

public GPApsisAltitudeParameters(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.

GPApsisAltitudeParameters

public GPApsisAltitudeParameters(String widgetId,
                                 String label,
                                 org.orekit.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

getGEntryRealHp

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

Getter for the GEntryReal defining the perigee geocentric altitude.

Returns:

the GEntryReal defining the perigee geocentric altitude.

getGEntryRealHa

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

Getter for the GEntryReal defining the apogee geocentric altitude.

Returns:

the GEntryReal defining the apogee geocentric altitude.

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).

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.

getTypeOfAnomaly

public org.orekit.orbits.PositionAngle getTypeOfAnomaly()

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

Returns:

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

setConstraint

public void setConstraint(int labelGap,
                          int paramsGap)

Setter for the constraints of the orbital parameters.

Overrides:

setConstraint in class GPParametersAbstractWithAnomaly

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(org.orekit.orbits.orbitalparameters.IOrbitalParameters params)
                               throws GPOrbitException

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

Specified by:

computeParamsArray in class GPParametersAbstractWithAnomaly

Parameters:

params - the orbital parameters as a IOrbitalParameters patrius object.

Returns:

the array of orbital parameters.

Throws:

GPOrbitException

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 org.orekit.orbits.orbitalparameters.IOrbitalParameters getPatriusObject()
                                                                        throws GPOrbitException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<org.orekit.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.

display

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

Specified by:

display in interface fr.cnes.genius.main.GDisplay

Overrides:

display in class GPParametersAbstractWithAnomaly

Throws:

fr.cnes.genius.exception.GException

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

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 - if the previous parameters are not valid

copyNullParams

protected double[] copyNullParams()

Initialize the array of orbital parameters to the null parameters defined by GPApsisAltitudeParameters#NULL_APSIS_PARAMS.

Overrides:

copyNullParams in class GPParametersAbstract

Returns:

an array of null orbital parameters.

setEnabled

public void setEnabled(boolean b)

Overrides:

setEnabled in class GPParametersAbstractWithAnomaly

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)

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.

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 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 GPParametersAbstractWithAnomaly

Throws:

fr.cnes.genius.exception.GComponentException