fr.cnes.genopus.attitudes
Class GPNadirPointingAttitudeLaw

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

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

public class GPNadirPointingAttitudeLaw
extends GPSpinStabilizedAbstract
implements GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape, fr.cnes.genius.main.GCondensedStatusInterface, GPPatriusWithObjects<CustomAttitudeLaw>

Widget for a nadir 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)

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"

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

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

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

GPNadirPointingAttitudeLaw(String label, CustomNadirPointing attitudeLaw)
Creates a new instance.

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

GPNadirPointingAttitudeLaw(String widgetId, String label, CustomNadirPointing attitudeLaw)
Creates a new instance.

Method Summary

void	before(fr.cnes.genius.main.GEvent e)
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.
org.orekit.bodies.BodyShape	getEarthShape() Getter for the Earth shape.
CustomAttitudeLaw	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
CustomAttitudeLaw	getPatriusObject(Object... args) 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.
boolean	isNativeAttitudeLaw(CustomAttitudeLaw attLaw) Method to check if an attitude law is an instance of this type.
void	setEarthShape(org.orekit.bodies.BodyShape earthShape) Setter for the Earth shape.
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.
protected void	updateStatus() Update the global status of the widget following the status of its components.

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

after, clear, displaySpinStabilizedData, getAvailableLawEvolutions, getGCheckBoxOccultAxis, getGComboBoxLawEvolution, getGEntryRealSpinRate, getGLabelSpinData, getGPAxisCoordinatesSpinAxis, getGPDateOffsetSpinDelay, getGPLawEvolutionEnum, getGSeparator2, getReferenceDate, getSpinnedLaw, getSubComponent, isModified, setAttitudeLaw, setAvailableLawEvolutions, setConstraint, setDefaultAttitudeLaw, setDisplayIsModifiedIndicatorAll, setEnabled, setGPLawEvolutionEnum, setReferenceDate, setSavedAttitudeLaw, setWidgetId, updateCondensedStatus, updateIsModifiedIndicator

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

display, getGLabelLawName, getGSeparator1, isEnabled, read, setDefaultConstraints, 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

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

updateCondensedStatus

Constructor Detail

GPNadirPointingAttitudeLaw

public GPNadirPointingAttitudeLaw(String label)

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

Parameters:

label - for the widget

GPNadirPointingAttitudeLaw

public GPNadirPointingAttitudeLaw(String widgetId,
                                  String label)

Creates a new instance.

Parameters:

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

label - for the widget

GPNadirPointingAttitudeLaw

public GPNadirPointingAttitudeLaw(String widgetId,
                                  String label,
                                  CustomNadirPointing 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

GPNadirPointingAttitudeLaw

public GPNadirPointingAttitudeLaw(String label,
                                  CustomNadirPointing 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

generic

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

Overrides:

generic in class GPSpinStabilizedAbstract

Throws:

fr.cnes.genius.exception.GException

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 spin start date is not defined

getPatriusObject

public CustomAttitudeLaw getPatriusObject(Object... args)
                                   throws fr.cnes.genius.exception.GException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatriusWithObjects<CustomAttitudeLaw>

Parameters:

args - The parameters are 0: BodyShape.

Returns:

the PATRIUS object associated to the widget.

Throws:

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

getPointingAxis

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.

Specified by:

getPointingAxis in class GPSpinStabilizedAbstract

Returns:

the requiered pointing axis for the spin stabilized attitude law.

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.

setEarthShape

public void setEarthShape(org.orekit.bodies.BodyShape earthShape)

Setter for the Earth shape.

Specified by:

setEarthShape in interface GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape

Parameters:

earthShape - the Earth shape.

getEarthShape

public org.orekit.bodies.BodyShape getEarthShape()

Getter for the Earth shape.

Specified by:

getEarthShape in interface GPAttitudeLawAbstract.GPAttitudeLawWithEarthShape

Returns:

the Earth shape.

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.

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

updateStatus

protected void updateStatus()

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

Overrides:

updateStatus in class GPAttitudeLawAbstract