fr.cnes.genopus.forces

Class GPRediffusedSRPForceModel

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.forces.GPRediffusedSRPForceModel

All Implemented Interfaces:

fr.cnes.genius.main.GClear, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GReadWrite, GPPatrius<CustomRediffusedRadiationPressure>, GPPatriusWithObjects<CustomRediffusedRadiationPressure>

public class GPRediffusedSRPForceModel
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.GListener, GPPatriusWithObjects<CustomRediffusedRadiationPressure>

Class containing the widget to define the rediffused Solar Radiation Pressure force model.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GCheckBoxWithIndicator	rediffusedSRPCheckBox	0, 0, 0 => "newline , gapleft 0 , split 2" 0, 0, 1 => (null) 0, 1 => (null)
1	GCheckBoxWithIndicator	rediffusedAlbedoCheckBox	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => (null)
2	GCheckBoxWithIndicator	rediffusedInfraredCheckBox	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => (null)
3	GEntryReal	multipRediffusedAlbedo	3, 0, 0 => "newline , gapleft 40 , split 2" 3, 0, 1 => (null) 3, 1 => (null)
4	GEntryReal	multipRediffusedInfrared	4, 0, 0 => "newline , gapleft 40 , split 2" 4, 0, 1 => (null) 4, 1 => (null)

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

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

GPPatriusWithObjects.ArgsChecker

Field Summary

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPRediffusedSRPForceModel(String widgetId, String label) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	after(fr.cnes.genius.main.GEvent e)
void	attachCopyPasteMenu(String label, fr.cnes.genius.main.GComponent.CopyPasteOperation... operationList)
void	before(fr.cnes.genius.main.GEvent e)
void	clear()
void	display()
void	generic()
fr.cnes.sirius.patrius.assembly.Assembly	getAssembly() Getter for the assembly to be used for drag force model creation.
org.orekit.frames.Frame	getEarthFrame() Getter for the Earth rotating frame.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxAlbedo() Getter for the GCheckBoxWithIndicator defining if the albedo is active.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxForceModel() Getter for the GCheckBoxWithIndicator defining if the force model is active.
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxInfrared() Getter for the GCheckBoxWithIndicator defining if the infrared is active.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealAlbedoMultip() Getter for the GEntryReal defining the albedo multiplicative factor.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealInfraredMultip() Getter for the GEntryReal defining the infrared multiplicative factor.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the GLabel of the widget.
double	getMultiplicativeFactorAlbedo() Get multiplicative factor for albedo domain.
double	getMultiplicativeFactorInfrared() Get multiplicative factor for infrared domain.
CustomRediffusedRadiationPressure	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
CustomRediffusedRadiationPressure	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
org.orekit.bodies.CelestialBody	getSun() Getter for the Sun celestial body to be used for drag force model creation.
boolean	isEnabled()
boolean	isModified()
boolean	isSelected() Checks if the rediffused SRP force is selected.
void	read()
void	setAssembly(fr.cnes.sirius.patrius.assembly.Assembly assembly) Setter for the assembly to be used for drag force model creation.
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setEarthFrame(org.orekit.frames.Frame earthFrame) Setter for the Earth rotating frame.
void	setEnabled(boolean b)
void	setMultiplicativeFactorAlbedo(double multiplicativeFactorAlbedo) Set multiplicative factor for albedo.
void	setMultiplicativeFactorInfrared(double multiplicativeFactorInfrared) Set multiplicative factor for infrared.
void	setSun(org.orekit.bodies.CelestialBody sun) Setter for the Sun celestial body.
protected void	updateIsModifiedIndicator()
void	write()

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

put

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

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

GPRediffusedSRPForceModel

public GPRediffusedSRPForceModel(String widgetId,
                         String label)

Constructor.

Parameters:

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

label - text to display in the label.

Method Detail

setConstraint

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

getGLabel

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

Getter for the GLabel of the widget.

Returns:

the GLabel of the widget

getGCheckBoxForceModel

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

Getter for the GCheckBoxWithIndicator defining if the force model is active.

Returns:

the GCheckBoxWithIndicator defining if the force model is active

getGCheckBoxAlbedo

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

Getter for the GCheckBoxWithIndicator defining if the albedo is active.

Returns:

the GCheckBoxWithIndicator defining if the albedo is active

getGEntryRealAlbedoMultip

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

Getter for the GEntryReal defining the albedo multiplicative factor.

Returns:

the GEntryReal defining the albedo multiplicative factor

getGCheckBoxInfrared

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

Getter for the GCheckBoxWithIndicator defining if the infrared is active.

Returns:

the GCheckBoxWithIndicator defining if the infrared is active

getGEntryRealInfraredMultip

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

Getter for the GEntryReal defining the infrared multiplicative factor.

Returns:

the GEntryReal defining the infrared multiplicative factor

setAssembly

public void setAssembly(fr.cnes.sirius.patrius.assembly.Assembly assembly)

Setter for the assembly to be used for drag force model creation. Requiered for the drag coefficient.

Parameters:

assembly - the assembly to be set.

getAssembly

public fr.cnes.sirius.patrius.assembly.Assembly getAssembly()

Getter for the assembly to be used for drag force model creation. Requiered for the drag coefficient.

Returns:

the internal assembly.

setEarthFrame

public void setEarthFrame(org.orekit.frames.Frame earthFrame)

Setter for the Earth rotating frame. Requiered for the force model.

Parameters:

earthFrame - the Earth rotating frame to be set.

getEarthFrame

public org.orekit.frames.Frame getEarthFrame()

Getter for the Earth rotating frame. Requiered for the force model.

Returns:

the internal Earth rotating frame.

setSun

public void setSun(org.orekit.bodies.CelestialBody sun)

Setter for the Sun celestial body. Requiered for the force model.

Parameters:

sun - the Sun celestial body to be used.

getSun

public org.orekit.bodies.CelestialBody getSun()

Getter for the Sun celestial body to be used for drag force model creation. Requiered for the atmosphere model.

Returns:

the internal Sun celestial body.

isEnabled

public boolean isEnabled()

Overrides:

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

setEnabled

public void setEnabled(boolean b)

Overrides:

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

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

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

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

getPatriusObject

public CustomRediffusedRadiationPressure getPatriusObject()
                                                   throws GPForcesException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<CustomRediffusedRadiationPressure>

Returns:

the PATRIUS object associated to the widget.

Throws:

GPForcesException - if the assembly, the Earth frame or the Sun body have not been initialized or if the Force model cannot be created

getPatriusObject

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

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatriusWithObjects<CustomRediffusedRadiationPressure>

Parameters:

args - The parameters are 0: Frame, 1: Assembly, 2: CelestialBody.

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.

isSelected

public boolean isSelected()

Checks if the rediffused SRP force is selected.

Returns:

true if the rediffused SRP force is selected, false otherwise.

setMultiplicativeFactorAlbedo

public void setMultiplicativeFactorAlbedo(double multiplicativeFactorAlbedo)
                                   throws fr.cnes.genius.exception.GArithmeticException

Set multiplicative factor for albedo.

Parameters:

multiplicativeFactorAlbedo - the multiplicativeFactorAlbedo to set

Throws:

fr.cnes.genius.exception.GArithmeticException - if multiplicativeFactorAlbedo is NaN.

setMultiplicativeFactorInfrared

public void setMultiplicativeFactorInfrared(double multiplicativeFactorInfrared)
                                     throws fr.cnes.genius.exception.GArithmeticException

Set multiplicative factor for infrared.

Parameters:

multiplicativeFactorInfrared - the multiplicativeFactorInfrared to set

Throws:

fr.cnes.genius.exception.GArithmeticException - if multiplicativeFactorInfrared is NaN.

getMultiplicativeFactorAlbedo

public double getMultiplicativeFactorAlbedo()

Get multiplicative factor for albedo domain.

Returns:

the multiplicativeFactorAlbedo

getMultiplicativeFactorInfrared

public double getMultiplicativeFactorInfrared()

Get multiplicative factor for infrared domain.

Returns:

the multiplicativeFactorInfrared

isModified

public boolean isModified()

Overrides:

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

Returns:

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Overrides:

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

attachCopyPasteMenu

public void attachCopyPasteMenu(String label,
                       fr.cnes.genius.main.GComponent.CopyPasteOperation... operationList)

Overrides:

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

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

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