fr.cnes.genopus.attitudes
Class GPSunPointingAttitudeLaw

java.lang.Object
  fr.cnes.genius.main.GComponent
      fr.cnes.genius.lowLevel.GContainer
          fr.cnes.genopus.attitudes.GPAttitudeLawAbstract
              fr.cnes.genopus.attitudes.GPSpinStabilizedAbstract
                  fr.cnes.genopus.attitudes.GPSunPointingAttitudeLaw

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

public class GPSunPointingAttitudeLaw
extends GPSpinStabilizedAbstract
implements fr.cnes.genius.main.GCondensedStatusInterface

Widget for a sun pointing 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	GComboBoxWithLabel	comboBoxLawEvol	2, 0, 0 => "newline , gapleft 0 , split 2" 2, 0, 1 => (null) 2, 1 => (null)
3	GPSpinStabilizedData	spinStabilizedData	"newline" (see table below)
4	GPAxisCoordinates	satSunDirectionAxis	"newline" (see table below)
5	GPAxisCoordinates	sunPolesDirectionAxis	"newline" (see table below)

Default Constraint(s) for spinStabilizedData:

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

Default Constraint(s) for dateOffsetSpinDelay:

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

Default Constraint(s) for axisCoordinatesSpinAxis:

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

Default Constraint(s) for satSunDirectionAxis:

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"

Default Constraint(s) for sunPolesDirectionAxis:

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

Nested Class Summary

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

GPSpinStabilizedAbstract.GPLawsEvolution

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

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

GPSunPointingAttitudeLaw(String label)
Creates a new instance.The widgetId will be assigned automatically.

GPSunPointingAttitudeLaw(String label, CustomSunPointing attitudeLaw)
Creates a new instance.

GPSunPointingAttitudeLaw(String widgetId, String label)
Creates a new instance.

GPSunPointingAttitudeLaw(String widgetId, String label, CustomSunPointing attitudeLaw)
Creates a new instance.

Method Summary

void	after(fr.cnes.genius.main.GEvent e)
void	before(fr.cnes.genius.main.GEvent e)
void	clear()
void	generic()
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D	getDefaultPointingAxis() Gets the pointing axis for the spin stabilized attitude law in case of comming from outside the spin stabilized data.
GPAxisCoordinates	getGPAxisCoordinatesFirstDirection() Getter for the Sun direction axis subwidget (first direction).
GPAxisCoordinates	getGPAxisCoordinatesSecondDirection() Getter for the Sun poles axis subwidget (second direction).
CustomAttitudeLaw	getLaw() Gets the PATRIUS attitude law object builded with MMI parameters.
CustomAttitudeLaw	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D	getPointingAxis() Gets the pointing axis for the spin stabilized attitude law in case of comming from outside the spin stabilized data.
protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D	getSavedPointingAxis() Gets the pointing axis for the spin stabilized attitude law in case of comming from outside the spin stabilized data.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isModified()
boolean	isNativeAttitudeLaw(CustomAttitudeLaw attLaw) Method to check if an attitude law is an instance of this type.
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all sub-widgets.
void	setEnabled(boolean flag)
protected void	setSubWidgetsDefaultValues(CustomAttitudeLaw attitudeLaw) Private method to set the default values to the sub-widgets related to the non-rotating law.
protected void	setSubWidgetsSavedValues(CustomAttitudeLaw attitudeLaw) Private method to set the saved values to the sub-widgets related to the non-rotating law.
protected void	setSubWidgetsValues(CustomAttitudeLaw attitudeLaw) Private method to set the values to the sub-widgets related to the non-rotating law.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)

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

displaySpinStabilizedData, getAvailableLawEvolutions, getGCheckBoxOccultAxis, getGComboBoxLawEvolution, getGEntryRealSpinRate, getGLabelSpinData, getGPAxisCoordinatesSpinAxis, getGPDateOffsetSpinDelay, getGPLawEvolutionEnum, getGSeparator2, getReferenceDate, getSpinnedLaw, setAttitudeLaw, setAvailableLawEvolutions, setDefaultAttitudeLaw, setGPLawEvolutionEnum, setReferenceDate, setSavedAttitudeLaw, updateIsModifiedIndicator

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

display, getGLabelLawName, getGSeparator1, isEnabled, read, setDefaultConstraints, 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, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, 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, 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

GPSunPointingAttitudeLaw

public GPSunPointingAttitudeLaw(String label)

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

Parameters:

label - for the widget

GPSunPointingAttitudeLaw

public GPSunPointingAttitudeLaw(String widgetId,
                                String label)

Creates a new instance.

Parameters:

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

label - for the widget

GPSunPointingAttitudeLaw

public GPSunPointingAttitudeLaw(String widgetId,
                                String label,
                                CustomSunPointing 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

GPSunPointingAttitudeLaw

public GPSunPointingAttitudeLaw(String label,
                                CustomSunPointing 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 GPSpinStabilizedAbstract

getGPAxisCoordinatesFirstDirection

public GPAxisCoordinates getGPAxisCoordinatesFirstDirection()

Getter for the Sun direction axis subwidget (first direction).

Returns:

the Sun direction axis subwidget (first direction)

getGPAxisCoordinatesSecondDirection

public GPAxisCoordinates getGPAxisCoordinatesSecondDirection()

Getter for the Sun poles axis subwidget (second direction).

Returns:

the Sun poles axis subwidget (second direction)

setConstraint

public void setConstraint(int widgetGap)

Setter for the constraints of the widget.

Overrides:

setConstraint in class GPSpinStabilizedAbstract

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 GPSpinStabilizedAbstract

Throws:

fr.cnes.genius.exception.GException

getLaw

public CustomAttitudeLaw getLaw()
                         throws GPAttitudeException

Gets the PATRIUS attitude law object builded with MMI parameters.

Returns:

attitude law (Patrius object)

Throws:

GPAttitudeException - if the sun cannot be built or if the spin start date is not defined

getPointingAxis

protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D getPointingAxis()
                                                                               throws GPAttitudeException

Gets the pointing axis for the spin stabilized attitude law in case of comming from outside the spin stabilized data.

Specified by:

getPointingAxis in class GPSpinStabilizedAbstract

Returns:

the requiered pointing axis for the spin stabilized attitude law.

Throws:

GPAttitudeException - if the axis is undefined.

getDefaultPointingAxis

protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D getDefaultPointingAxis()
                                                                                      throws GPAttitudeException

Gets the pointing axis for the spin stabilized attitude law in case of comming from outside the spin stabilized data.

Specified by:

getDefaultPointingAxis in class GPSpinStabilizedAbstract

Returns:

the requiered pointing axis for the spin stabilized attitude law.

Throws:

GPAttitudeException - in case of any problem.

getSavedPointingAxis

protected org.apache.commons.math3.geometry.euclidean.threed.Vector3D getSavedPointingAxis()
                                                                                    throws GPAttitudeException

Gets the pointing axis for the spin stabilized attitude law in case of comming from outside the spin stabilized data.

Specified by:

getSavedPointingAxis in class GPSpinStabilizedAbstract

Returns:

the requiered pointing axis for the spin stabilized attitude law.

Throws:

GPAttitudeException - in case of any problem.

getPatriusObject

public CustomAttitudeLaw getPatriusObject()
                                   throws GPAttitudeException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<CustomAttitudeLaw>

Specified by:

getPatriusObject in class GPAttitudeLawAbstract

Returns:

the PATRIUS object associated to the widget.

Throws:

GPAttitudeException - if the sun cannot be built or if the spin start date is not defined

clear

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

Specified by:

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

Overrides:

clear in class GPSpinStabilizedAbstract

Throws:

fr.cnes.genius.exception.GException

setEnabled

public void setEnabled(boolean flag)

Overrides:

setEnabled in class GPSpinStabilizedAbstract

isNativeAttitudeLaw

public boolean isNativeAttitudeLaw(CustomAttitudeLaw 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.

setSubWidgetsValues

protected void setSubWidgetsValues(CustomAttitudeLaw attitudeLaw)

Private method to set the values to the sub-widgets related to the non-rotating law.

Specified by:

setSubWidgetsValues in class GPSpinStabilizedAbstract

Parameters:

attitudeLaw - PATRIUS attitude law. Must be of native type.

setSubWidgetsDefaultValues

protected void setSubWidgetsDefaultValues(CustomAttitudeLaw attitudeLaw)

Private method to set the default values to the sub-widgets related to the non-rotating law.

Specified by:

setSubWidgetsDefaultValues in class GPSpinStabilizedAbstract

Parameters:

attitudeLaw - PATRIUS attitude law. Must be of native type.

setSubWidgetsSavedValues

protected void setSubWidgetsSavedValues(CustomAttitudeLaw attitudeLaw)

Private method to set the saved values to the sub-widgets related to the non-rotating law.

Specified by:

setSubWidgetsSavedValues in class GPSpinStabilizedAbstract

Parameters:

attitudeLaw - PATRIUS attitude law. Must be of native type.

updateCondensedStatus

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

Specified by:

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

Overrides:

updateCondensedStatus in class GPSpinStabilizedAbstract

setDisplayIsModifiedIndicatorAll

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

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

Overrides:

setDisplayIsModifiedIndicatorAll in class GPSpinStabilizedAbstract

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 GPSpinStabilizedAbstract

getSubComponent

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

Overrides:

getSubComponent in class GPSpinStabilizedAbstract

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

Overrides:

after in class GPSpinStabilizedAbstract

Throws:

fr.cnes.genius.exception.GException