fr.cnes.genopus.attitudes

Class GPAeroAttitudeLaw

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.attitudes.GPAttitudeLawAbstract

fr.cnes.genopus.attitudes.GPAeroAttitudeLaw

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, GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape, GPPatrius<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>, GPPatriusWithObjects<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>

public class GPAeroAttitudeLaw
extends GPAttitudeLawAbstract
implements GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GListener, GPPatriusWithObjects<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>

Widget for an aero attitude law.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	labelLawName	0, 0 => "newline , gapleft 0 , split 2" 0, 1 => (null)
1	GSeparator	separator1	"newline , gapleft 0 , spanx 3 , growx"
2	GEntryReal	entryRealAngleOfAttack	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => "split 2" 2, 2 => (null)
3	GEntryReal	entryRealSideSlipAngle	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 3, 1 => "split 2" 3, 2 => (null)
4	GEntryReal	entryRealBankAngle	4, 0, 0 => "newline , gapleft 20 , split 2" 4, 0, 1 => (null) 4, 1 => "split 2" 4, 2 => (null)

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genopus.attitudes.GPAttitudeLawAbstract

GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape

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

Nested classes/interfaces inherited from interface fr.cnes.genopus.main.GPPatriusWithObjects

GPPatriusWithObjects.ArgsChecker

Field Summary

Fields inherited from class fr.cnes.genopus.attitudes.GPAttitudeLawAbstract

ANGLE_UNITS, ANGULAR_SPEED_UNITS, SUB_GAP

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPAeroAttitudeLaw(String label) Creates a new instance.The widgetId will be assigned automatically.
GPAeroAttitudeLaw(String label, fr.cnes.sirius.patrius.attitudes.AeroAttitudeLaw attitudeLaw) Creates a new instance.
GPAeroAttitudeLaw(String widgetId, String label) Creates a new instance.
GPAeroAttitudeLaw(String widgetId, String label, fr.cnes.sirius.patrius.attitudes.AeroAttitudeLaw attitudeLaw) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
void	after(fr.cnes.genius.main.GEvent e)
void	before(fr.cnes.genius.main.GEvent e)
void	clear()
void	generic()
fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid	getEarthShape() Getter for the Earth shape.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealAngleOfAttack() Getter for the angle of attack subwidget.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealBankAngle() Getter for the bank angle subwidget.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealSideSlipAngle() Getter for the side slip angle subwidget.
fr.cnes.sirius.patrius.attitudes.AttitudeLaw	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.sirius.patrius.attitudes.AttitudeLaw	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isModified()
boolean	isNativeAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw attLaw) Method to check if an attitude law is an instance of this type.
void	setAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw attitudeLaw) Setter from a PATRIUS attitude law.
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setDefaultAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw defaultAttitudeLaw) Setter of the default value from a PATRIUS attitude law.
void	setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all sub-widgets.
void	setEarthShape(fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid earthShape) Setter for the Earth shape.
void	setEnabled(boolean flag)
void	setSavedAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw savedAttitudeLaw) Setter of the saved value from a PATRIUS attitude law.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)

Methods inherited from class fr.cnes.genopus.attitudes.GPAttitudeLawAbstract

display, getGLabelLawName, getGSeparator1, isEnabled, read, setDefaultConstraints, updateIsModifiedIndicator, updateStatus, write

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

put

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

activateConstraintsByType, attachCopyPasteMenu, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setNameAndCommentInConfigFile, setNameInConfigFile, setStatus, setStringConstraint, setToolTipText, 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

Constructor Detail

GPAeroAttitudeLaw

public GPAeroAttitudeLaw(String label)

Creates a new instance.The widgetId will be assigned automatically.

Parameters:

label - for the widget

GPAeroAttitudeLaw

public GPAeroAttitudeLaw(String widgetId,
                 String label)

Creates a new instance.

Parameters:

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

label - for the widget

GPAeroAttitudeLaw

public GPAeroAttitudeLaw(String widgetId,
                 String label,
                 fr.cnes.sirius.patrius.attitudes.AeroAttitudeLaw attitudeLaw)

Creates a new instance.

Parameters:

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

label - for the widget

attitudeLaw - attitude law to initialize the widget

GPAeroAttitudeLaw

public GPAeroAttitudeLaw(String label,
                 fr.cnes.sirius.patrius.attitudes.AeroAttitudeLaw attitudeLaw)

Creates a new instance. The widgetId will be asigned automatically.

Parameters:

label - for the widget

attitudeLaw - attitude law to initialize the widget

Method Detail

setWidgetId

public void setWidgetId(String widgetId)

Overrides:

setWidgetId in class GPAttitudeLawAbstract

getGEntryRealAngleOfAttack

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

Getter for the angle of attack subwidget.

Returns:

the angle of attack subwidget

getGEntryRealSideSlipAngle

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

Getter for the side slip angle subwidget.

Returns:

the side slip angle subwidget

getGEntryRealBankAngle

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

Getter for the bank angle subwidget.

Returns:

the bank angle subwidget

setConstraint

public void setConstraint(int widgetGap)

Setter for the constraints of the widget.

Overrides:

setConstraint in class GPAttitudeLawAbstract

Parameters:

widgetGap - left gap from panel border to display the label of the widget.

generic

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

Overrides:

generic in class GPAttitudeLawAbstract

Throws:

fr.cnes.genius.exception.GException

getPatriusObject

public fr.cnes.sirius.patrius.attitudes.AttitudeLaw getPatriusObject(Object... args)
                                                              throws fr.cnes.genius.exception.GException,
                                                                     fr.cnes.sirius.patrius.utils.exception.PatriusException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatriusWithObjects<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>

Parameters:

args - The parameters are 0: ExtendedOneAxisEllipsoid.

Returns:

the PATRIUS object associated to the widget.

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException

fr.cnes.genius.exception.GException - if the PATRIUS object cannot be created from the widget data.

getPatriusObject

public fr.cnes.sirius.patrius.attitudes.AttitudeLaw getPatriusObject()
                                                              throws fr.cnes.sirius.patrius.utils.exception.PatriusException,
                                                                     GPAttitudeException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>

Specified by:

getPatriusObject in class GPAttitudeLawAbstract

Returns:

the PATRIUS object associated to the widget.

Throws:

fr.cnes.sirius.patrius.utils.exception.PatriusException - if the earth shape has not been initialized

GPAttitudeException

setEarthShape

public void setEarthShape(fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid earthShape)
                   throws fr.cnes.genius.exception.GArithmeticException

Setter for the Earth shape.

Specified by:

setEarthShape in interface GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape

Parameters:

earthShape - the Earth shape.

Throws:

fr.cnes.genius.exception.GArithmeticException - if equatorial radius or flatness in earthShape are NaN

getEarthShape

public fr.cnes.sirius.patrius.bodies.ExtendedOneAxisEllipsoid getEarthShape()

Getter for the Earth shape.

Specified by:

getEarthShape in interface GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape

Returns:

the Earth shape.

clear

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

Specified by:

clear in interface fr.cnes.genius.main.GClear

Throws:

fr.cnes.genius.exception.GException

setEnabled

public void setEnabled(boolean flag)

Overrides:

setEnabled in class GPAttitudeLawAbstract

isNativeAttitudeLaw

public boolean isNativeAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw attLaw)

Method to check if an attitude law is an instance of this type.

Specified by:

isNativeAttitudeLaw in class GPAttitudeLawAbstract

Parameters:

attLaw - input attitude law.

Returns:

true if it is an instance of this.

setAttitudeLaw

public void setAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw attitudeLaw)
                    throws GPAttitudeException,
                           fr.cnes.genius.exception.GArithmeticException

Setter from a PATRIUS attitude law.

Specified by:

setAttitudeLaw in class GPAttitudeLawAbstract

Parameters:

attitudeLaw - to be set in the widget

Throws:

fr.cnes.genius.exception.GArithmeticException - if the angle of attack, the side slip angle or the bank angle in attitudeLaw are NaN.

GPAttitudeException - if the given attitude law is not compatible with the widget.

setDefaultAttitudeLaw

public void setDefaultAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw defaultAttitudeLaw)
                           throws GPAttitudeException,
                                  fr.cnes.genius.exception.GArithmeticException

Setter of the default value from a PATRIUS attitude law.

Specified by:

setDefaultAttitudeLaw in class GPAttitudeLawAbstract

Parameters:

defaultAttitudeLaw - to be set as default in the widget

Throws:

fr.cnes.genius.exception.GArithmeticException - if the angle of attack, the side slip angle or the bank angle in attitudeLaw are NaN.

GPAttitudeException - if the given attitude law is not compatible with the widget.

setSavedAttitudeLaw

public void setSavedAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw savedAttitudeLaw)
                         throws GPAttitudeException,
                                fr.cnes.genius.exception.GArithmeticException

Setter of the saved value from a PATRIUS attitude law.

Specified by:

setSavedAttitudeLaw in class GPAttitudeLawAbstract

Parameters:

savedAttitudeLaw - to be set as saved in the widget

Throws:

fr.cnes.genius.exception.GArithmeticException - if the angle of attack, the side slip angle or the bank angle in attitudeLaw are NaN.

GPAttitudeException - if the given attitude law is not compatible with the widget.

updateCondensedStatus

public void updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)

Specified by:

updateCondensedStatus in interface fr.cnes.genius.main.GCondensedStatusInterface

setDisplayIsModifiedIndicatorAll

public void setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus)

Controls the display of the isModified indicator of all sub-widgets.

Specified by:

setDisplayIsModifiedIndicatorAll in class GPAttitudeLawAbstract

Parameters:

displayIndicatorStatus - if Always the modifiedStatusIndicator is always shown, if Never the modifiedStatusIndicator is never shown, if Automatic the modifiedStatusIndicator is shown as needed.

isModified

public boolean isModified()

Overrides:

isModified in class fr.cnes.genius.main.GComponent

getSubComponent

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

Overrides:

getSubComponent in class GPAttitudeLawAbstract

Throws:

fr.cnes.genius.exception.GComponentException

before

public void before(fr.cnes.genius.main.GEvent e)
            throws fr.cnes.genius.exception.GException

Specified by:

before in interface fr.cnes.genius.main.GListener

Throws:

fr.cnes.genius.exception.GException

after

public void after(fr.cnes.genius.main.GEvent e)
           throws fr.cnes.genius.exception.GException

Specified by:

after in interface fr.cnes.genius.main.GListener

Throws:

fr.cnes.genius.exception.GException