fr.cnes.genopus.attitudes

Class GPSpinStabilizedData

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.attitudes.GPSpinStabilizedData

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, MouseWheelListener, EventListener

public class GPSpinStabilizedData
extends fr.cnes.genius.lowLevel.GContainer
implements fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GClear, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GListener

Widget for spinned stabilized attitude data.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GSeparator	separator2	"newline , gapleft 0 , spanx 3 , growx"
1	GLabelWithIndicator	labelSpinData	1, 0 => "newline , gapleft 0 , split 2" 1, 1 => (null)
2	GPDateOffset	dateOffsetSpinDelay	"newline" (see table below)
3	GCheckBoxWithIndicator	checkboxOccultAxis	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 3, 1 => (null)
4	GPAxisCoordinates	axisCoordinatesSpinAxis	"newline" (see table below)
5	GEntryReal	entryRealSpinRate	5, 0, 0 => "newline , gapleft 20 , split 2" 5, 0, 1 => (null) 5, 1 => "split 2" 5, 2 => (null)

Default Constraint(s) for dateOffsetSpinDelay:

Index	Class	Item	Constraint
2, 0	GLabelWithIndicator	label	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null)
2, 1	GPDateOffsetField	offsetField	"split 2"
2, 2	GPopupList	popupListUnits	(null)

Default Constraint(s) for axisCoordinatesSpinAxis:

Index	Class	Item	Constraint
4, 0	GLabelWithIndicator	label	4, 0, 0 => "newline , gapleft 20 , split 2" 4, 0, 1 => (null)
4, 1	GComboBoxWithLabel	comboBoxType	4, 1, 0, 0 => "newline , gapleft 40 , split 2" 4, 1, 0, 1 => (null) 4, 1, 1 => (null)
4, 2	GEntryReal	entryRealVecX	4, 2, 0, 0 => "newline , gapleft 40 , split 2" 4, 2, 0, 1 => (null) 4, 2, 1 => "split 2"
4, 3	GEntryReal	entryRealVecY	4, 3, 0, 0 => "newline , gapleft 40 , split 2" 4, 3, 0, 1 => (null) 4, 3, 1 => "split 2"
4, 4	GEntryReal	entryRealVecZ	4, 4, 0, 0 => "newline , gapleft 40 , split 2" 4, 4, 0, 1 => (null) 4, 4, 1 => "split 2"
4, 5	GEntryReal	entryRealAlfa	4, 5, 0, 0 => "newline , gapleft 40 , split 2" 4, 5, 0, 1 => (null) 4, 5, 1 => "split 2" 4, 5, 2 => (null)
4, 6	GEntryReal	entryRealBeta	4, 6, 0, 0 => "newline , gapleft 40 , split 2" 4, 6, 0, 1 => (null) 4, 6, 1 => "split 2" 4, 6, 2 => (null)
4, 7	GEntryReal	entryRealNorm	4, 7, 0, 0 => "newline , gapleft 40 , split 2" 4, 7, 0, 1 => (null) 4, 7, 1 => "split 2"

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 inherited from class fr.cnes.genius.main.GComponent

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPSpinStabilizedData() Empty constructor.
GPSpinStabilizedData(String widgetId, boolean withShowAxisMechanism, String checkboxTooltip) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	after(fr.cnes.genius.main.GEvent e)
boolean	axisIsDefined() True if the spin axis is defined (if it is not hidden).
void	before(fr.cnes.genius.main.GEvent e)
void	clear()
boolean	defaultAxisIsDefined() True if the spin axis is hidden by default.
void	display()
void	generic()
fr.cnes.sirius.patrius.math.geometry.euclidean.threed.Vector3D	getDefaultSpinAxis() Get 3D vector.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxOccultAxis() Getter for the checkbox to show/occult axis.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealSpinRate() Getter for the spin rate subwidget.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabelSpinData() Getter for the spin data label subwidget.
GPAxisCoordinates	getGPAxisCoordinatesSpinAxis() Get spin axis subwidget.
GPDateOffset	getGPDateOffsetSpinDelay() Getter for the spin delay subwidget.
fr.cnes.genius.lowLevel.GSeparator	getGSeparator2() Getter for the separator subwidget before the spin data.
fr.cnes.sirius.patrius.time.AbsoluteDate	getReferenceDate() Method to get the reference date for the attitude laws.
fr.cnes.sirius.patrius.time.TimeScale	getReferenceTimeScale() Method to get the reference time scale for the attitude laws.
fr.cnes.sirius.patrius.math.geometry.euclidean.threed.Vector3D	getSavedSpinAxis() Get 3D vector.
fr.cnes.sirius.patrius.math.geometry.euclidean.threed.Vector3D	getSpinAxis() Get 3D vector.
double	getSpinRate() Get rotation.
fr.cnes.sirius.patrius.time.AbsoluteDate	getSpinStartDate() Get the spin start absolute date as the sum of the reference date and the delay.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isEnabled()
boolean	isModified()
void	read()
boolean	savedAxisIsDefined() True if the spin axis is saved as hidden.
void	setConstraint(int widgetGap) Setter for th e constraints of the widget.
void	setData(fr.cnes.sirius.patrius.attitudes.SpinStabilized spinStabilizedAttitudeLaw) Setter for the spin stabilized data.
void	setDefaultConstraints() Setter for the default constraint of the widget.
void	setDefaultData(fr.cnes.sirius.patrius.attitudes.SpinStabilized spinStabilizedAttitudeLaw) Setter for the default values of the spin stabilized data.
void	setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all sub-widgets.
void	setEnabled(boolean flag)
void	setReferenceDate(fr.cnes.sirius.patrius.time.AbsoluteDate refDate, fr.cnes.sirius.patrius.time.TimeScale timeScale) Method to set the reference date for the attitude laws.
void	setSavedData(fr.cnes.sirius.patrius.attitudes.SpinStabilized spinStabilizedAttitudeLaw) Setter for the saved values of the spin stabilized data.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
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, 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

Constructor Detail

GPSpinStabilizedData

public GPSpinStabilizedData()

Empty constructor. Identifier will be automatically created

GPSpinStabilizedData

public GPSpinStabilizedData(String widgetId,
                            boolean withShowAxisMechanism,
                            String checkboxTooltip)

Creates a new instance.

Parameters:

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

withShowAxisMechanism - true to activate the mecanism to hide the axis coordinates depending on a checkbox.

checkboxTooltip - tooltip to associate to the checkbox that hides the axis coordinates.

Method Detail

setWidgetId

public void setWidgetId(String widgetId)

Overrides:

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

getGSeparator2

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

Getter for the separator subwidget before the spin data.

Returns:

the separator subwidget before the spin data

getGLabelSpinData

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

Getter for the spin data label subwidget.

Returns:

the spin data label subwidget

getGPDateOffsetSpinDelay

public GPDateOffset getGPDateOffsetSpinDelay()

Getter for the spin delay subwidget.

Returns:

the spin delay subwidget

getGCheckBoxOccultAxis

public fr.cnes.genius.highLevel.GCheckBoxWithIndicator getGCheckBoxOccultAxis()

Getter for the checkbox to show/occult axis.

Returns:

the checkbox to show/occult axis.

getGPAxisCoordinatesSpinAxis

public GPAxisCoordinates getGPAxisCoordinatesSpinAxis()

Get spin axis subwidget.

Returns:

the spin axis subwidget

getGEntryRealSpinRate

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

Getter for the spin rate subwidget.

Returns:

the spin rate subwidget

setDefaultConstraints

public void setDefaultConstraints()

Setter for the default constraint of the widget.

Overrides:

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

setConstraint

public void setConstraint(int widgetGap)

Setter for th e 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

getSpinStartDate

public fr.cnes.sirius.patrius.time.AbsoluteDate getSpinStartDate()
                                                          throws GPAttitudeException

Get the spin start absolute date as the sum of the reference date and the delay.

Returns:

the spin start absolute date.

Throws:

GPAttitudeException - if the reference date is undefined.

getSpinAxis

public fr.cnes.sirius.patrius.math.geometry.euclidean.threed.Vector3D getSpinAxis()
                                                                           throws GPAttitudeException

Get 3D vector.

Returns:

the 3D vector

Throws:

GPAttitudeException - if the axis is undefined.

getSavedSpinAxis

public fr.cnes.sirius.patrius.math.geometry.euclidean.threed.Vector3D getSavedSpinAxis()
                                                                                throws GPAttitudeException

Get 3D vector.

Returns:

the 3D vector

Throws:

GPAttitudeException - if the axis is undefined.

getDefaultSpinAxis

public fr.cnes.sirius.patrius.math.geometry.euclidean.threed.Vector3D getDefaultSpinAxis()
                                                                                  throws GPAttitudeException

Get 3D vector.

Returns:

the 3D vector

Throws:

GPAttitudeException - if the axis is undefined.

getSpinRate

public double getSpinRate()

Get rotation.

Returns:

the rotation

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

setData

public void setData(fr.cnes.sirius.patrius.attitudes.SpinStabilized spinStabilizedAttitudeLaw)
             throws GPAttitudeException,
                    fr.cnes.genius.exception.GArithmeticException

Setter for the spin stabilized data.

Parameters:

spinStabilizedAttitudeLaw - the spin stabilized attitude law.

Throws:

GPAttitudeException - if the absolute value of the delay (in days) is too high.

fr.cnes.genius.exception.GArithmeticException - if for spinStabilizedAttitudeLaw its rotation start date contains NaN, if its rotation axis contains NaN or has zero norm or if its spin rate is NaN.

setDefaultData

public void setDefaultData(fr.cnes.sirius.patrius.attitudes.SpinStabilized spinStabilizedAttitudeLaw)
                    throws GPAttitudeException,
                           fr.cnes.genius.exception.GArithmeticException

Setter for the default values of the spin stabilized data.

Parameters:

spinStabilizedAttitudeLaw - the spin stabilized attitude law.

Throws:

GPAttitudeException - if the absolute value of the delay (in days) is too high.

fr.cnes.genius.exception.GArithmeticException - if for spinStabilizedAttitudeLaw its rotation start date contains NaN, if its rotation axis contains NaN or has zero norm or if its spin rate is NaN.

setSavedData

public void setSavedData(fr.cnes.sirius.patrius.attitudes.SpinStabilized spinStabilizedAttitudeLaw)
                  throws GPAttitudeException,
                         fr.cnes.genius.exception.GArithmeticException

Setter for the saved values of the spin stabilized data.

Parameters:

spinStabilizedAttitudeLaw - the spin stabilized attitude law.

Throws:

GPAttitudeException - if the absolute value of the delay (in days) is too high.

fr.cnes.genius.exception.GArithmeticException - if for spinStabilizedAttitudeLaw its rotation start date contains NaN, if its rotation axis contains NaN or has zero norm or if its spin rate is NaN.

setReferenceDate

public void setReferenceDate(fr.cnes.sirius.patrius.time.AbsoluteDate refDate,
                             fr.cnes.sirius.patrius.time.TimeScale timeScale)
                      throws fr.cnes.genius.exception.GArithmeticException

Method to set the reference date for the attitude laws.

Parameters:

refDate - reference date

timeScale - time scale for the time offsets of the spin stabilized laws

Throws:

fr.cnes.genius.exception.GArithmeticException - if the date contains a NaN value in the double for the seconds in day (offset attribut)

getReferenceDate

public fr.cnes.sirius.patrius.time.AbsoluteDate getReferenceDate()
                                                          throws GPAttitudeException

Method to get the reference date for the attitude laws.

Returns:

reference date

Throws:

GPAttitudeException - if the reference date is undefined.

getReferenceTimeScale

public fr.cnes.sirius.patrius.time.TimeScale getReferenceTimeScale()

Method to get the reference time scale for the attitude laws.

Returns:

reference time scale

updateCondensedStatus

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

Specified by:

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

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

isModified

public boolean isModified()

Overrides:

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

setDisplayIsModifiedIndicatorAll

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

axisIsDefined

public boolean axisIsDefined()

True if the spin axis is defined (if it is not hidden).

Returns:

true if the axis is defined

savedAxisIsDefined

public boolean savedAxisIsDefined()

True if the spin axis is saved as hidden.

Returns:

true if the spin axis is saved as hidden.

defaultAxisIsDefined

public boolean defaultAxisIsDefined()

True if the spin axis is hidden by default.

Returns:

true if the spin axis is hidden by default.

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

updateStatus

protected void updateStatus()

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