fr.cnes.genopus.attitudes

Class GPAttitudeLawAbstract

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.attitudes.GPAttitudeLawAbstract

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GReadWrite, GPPatrius<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>, MouseWheelListener, EventListener

Direct Known Subclasses:

GPAeroAttitudeLaw, GPSpinStabilizedAbstract, GPYawSteeringAttitudeLaw

public abstract class GPAttitudeLawAbstract
extends fr.cnes.genius.lowLevel.GContainer
implements fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GClear, GPPatrius<fr.cnes.sirius.patrius.attitudes.AttitudeLaw>, fr.cnes.genius.main.GCondensedStatusInterface

Abstract class defining the default methods to be implemented by any attitude law class.

Author:

ffsm

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape Interface to be implemented by all the types of attitude law requiering the Earth Shape.

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 fr.cnes.genius.unit.GUnit[]	ANGLE_UNITS Angular units.
static fr.cnes.genius.unit.GUnit[]	ANGULAR_SPEED_UNITS Angular speed units.
protected static int	SUB_GAP Subsequent left gap for subwidgets.

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPAttitudeLawAbstract() Empty constructor.
GPAttitudeLawAbstract(String widgetId, String label) Constructor.

Method Summary

Modifier and Type	Method and Description
void	display()
void	generic()
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabelLawName() Getter for the label name subwidget.
fr.cnes.genius.lowLevel.GSeparator	getGSeparator1() Getter for the separator subwidget after the law name label.
abstract fr.cnes.sirius.patrius.attitudes.AttitudeLaw	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isEnabled()
abstract boolean	isNativeAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw attLaw) Method to check if an attitude law is an instance of this type.
void	read()
abstract void	setAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw attitudeLaw) Setter from a PATRIUS attitude law.
protected void	setConstraint(int widgetGap) Setter for the constraints of the widget.
abstract void	setDefaultAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw defaultAttitudeLaw) Setter of the default value from a PATRIUS attitude law.
protected void	setDefaultConstraints() Setter for the default constraint of the widget.
abstract void	setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all sub-widgets.
void	setEnabled(boolean flag)
abstract void	setSavedAttitudeLaw(fr.cnes.sirius.patrius.attitudes.AttitudeLaw savedAttitudeLaw) Setter of the saved value from a PATRIUS attitude law.
void	setWidgetId(String widgetId)
protected void	updateIsModifiedIndicator()
protected void	updateStatus() Update the global status of the widget following the status of its components.
void	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, isModified, launchInvalidPositionException, mouseWheelMoved, parseSimpleConstraint, processGEvent, processMouseWheelEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setName, setNameAndCommentInConfigFile, setNameInConfigFile, setPathInConfigFile, setStatus, setStringConstraint, setToolTipText, setWidth, setWindowBusyCursor, 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

Methods inherited from interface fr.cnes.genius.main.GClear

clear

Methods inherited from interface fr.cnes.genius.main.GCondensedStatusInterface

updateCondensedStatus

Field Detail

ANGLE_UNITS

public static final fr.cnes.genius.unit.GUnit[] ANGLE_UNITS

Angular units.

ANGULAR_SPEED_UNITS

public static final fr.cnes.genius.unit.GUnit[] ANGULAR_SPEED_UNITS

Angular speed units.

SUB_GAP

protected static final int SUB_GAP

Subsequent left gap for subwidgets.

See Also:

Constant Field Values

Constructor Detail

GPAttitudeLawAbstract

public GPAttitudeLawAbstract()

Empty constructor.

GPAttitudeLawAbstract

public GPAttitudeLawAbstract(String widgetId,
                             String label)

Constructor.

Parameters:

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

label - label for the attitude law contents section.

Method Detail

setWidgetId

public void setWidgetId(String widgetId)

Overrides:

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

getGSeparator1

public fr.cnes.genius.lowLevel.GSeparator getGSeparator1()

Getter for the separator subwidget after the law name label.

Returns:

the separator subwidget after the law name label

getGLabelLawName

public fr.cnes.genius.highLevel.GLabelWithIndicator getGLabelLawName()

Getter for the label name subwidget.

Returns:

the label name subwidget

setDefaultConstraints

protected void setDefaultConstraints()

Setter for the default constraint of the widget.

Overrides:

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

setConstraint

protected void setConstraint(int widgetGap)

Setter for the constraints of the widget.

Parameters:

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

display

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

Specified by:

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

Throws:

fr.cnes.genius.exception.GException

read

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

Specified by:

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

Throws:

fr.cnes.genius.exception.GException

write

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

Specified by:

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

Throws:

fr.cnes.genius.exception.GException

generic

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

Specified by:

generic in class fr.cnes.genius.lowLevel.GContainer

Throws:

fr.cnes.genius.exception.GException

isNativeAttitudeLaw

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

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

Parameters:

attLaw - input attitude law.

Returns:

true if it is an instance of this.

setAttitudeLaw

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

Setter from a PATRIUS attitude law.

Parameters:

attitudeLaw - to be set in the widget

Throws:

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

fr.cnes.genius.exception.GArithmeticException - if attitudeLaw contain NaNs.

setDefaultAttitudeLaw

public abstract 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.

Parameters:

defaultAttitudeLaw - to be set as default in the widget

Throws:

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

fr.cnes.genius.exception.GArithmeticException - if attitudeLaw contain NaNs.

setSavedAttitudeLaw

public abstract 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.

Parameters:

savedAttitudeLaw - to be set as saved in the widget

Throws:

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

fr.cnes.genius.exception.GArithmeticException - if attitudeLaw contain NaNs.

setDisplayIsModifiedIndicatorAll

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

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

Parameters:

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

getPatriusObject

public abstract 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>

Returns:

the PATRIUS object associated to the widget.

Throws:

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

GPAttitudeException

getSubComponent

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

Overrides:

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

Throws:

fr.cnes.genius.exception.GComponentException

setEnabled

public void setEnabled(boolean flag)

Overrides:

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

isEnabled

public boolean isEnabled()

Overrides:

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

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Overrides:

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

updateStatus

protected void updateStatus()

Update the global status of the widget following the status of its components.