fr.cnes.genopus.maneuvers

Class GPEngine

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genopus.maneuvers.GPEngine

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<CustomEngine>, Cloneable

public class GPEngine
extends fr.cnes.genius.lowLevel.GPanel
implements fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GCondensedStatusInterface, fr.cnes.genius.main.GClear, Cloneable, GPPatrius<CustomEngine>

Widget for engine definition.

Author:

sumelzi, bacr

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0" 0, 1 => (null)
1	GEntryString	entryStringName	1, 0, 0 => "newline , gapleft 20" 1, 0, 1 => (null) 1, 1 => (null)
2	GEntryReal	entryRealIsp	2, 0, 0 => "newline , gapleft 20" 2, 0, 1 => (null) 2, 1 => (null) 2, 2 => (null)
3	GEntryReal	entryRealThrust	3, 0, 0 => "newline , gapleft 20" 3, 0, 1 => (null) 3, 1 => (null) 3, 2 => (null)

Nested Class Summary

Nested classes/interfaces inherited from class fr.cnes.genius.lowLevel.GPanel

fr.cnes.genius.lowLevel.GPanel.Panel, fr.cnes.genius.lowLevel.GPanel.ScrollBarVisibility

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
GPEngine() Constructor without engine and label (convenient for GComponentList).
GPEngine(CustomEngine engine) Constructor.
GPEngine(String engineName) Constructor without engine.
GPEngine(String engineName, CustomEngine engine) Constructor.
GPEngine(String widgetId, String engineName) Constructor.
GPEngine(String widgetId, String label, CustomEngine engine) 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)
static void	checkEngine(CustomEngine engine) Checks if the thrust or the isp of the input engine are NaN.
void	clear()
GPEngine	clone()
void	display()
void	generic()
static int	getCount() Getter for the engines counter.
String	getEngineName() Get engine name.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealIsp() Getter for the GEntryReal (m_isp) of the widget.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealThrust() Getter for the GEntryReal (m_thrust) of the widget.
fr.cnes.genius.highLevel.GEntryString	getGEntryStingEngineName() Getter for the GEntryString (m_engineName) of the widget.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the GLabel of the widget.
CustomEngine	getPatriusObject() Get engine.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
boolean	isEnabled()
boolean	isModified()
void	read()
static void	setCount(int count) Getter for the engines counter.
void	setDefaultEngine(CustomEngine defaultEngine) Setter for the default engine.
void	setEnabled(boolean b)
void	setEngine(CustomEngine engine) Setter for the engine.
void	setSavedEngine(CustomEngine savedEngine) Setter for the reference engine.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
void	updateIsModifiedIndicator()
void	write()

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

getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, put, setClassConstraint, setColumnConstraints, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setPreferredSize, setRowConstraints, setVerticalScroll

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

activateConstraintsByType, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, 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, setWidth, writeCollection, writeCollection, writeCollection, writeCollection, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem, writeConfigItem

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GPEngine

public GPEngine()

Constructor without engine and label (convenient for GComponentList). The widgetId will be assigned automatically.

GPEngine

public GPEngine(CustomEngine engine)

Constructor. The widgetId and the label will be assigned automatically.

Parameters:

engine - default engine to set in the widget.

GPEngine

public GPEngine(String engineName)

Constructor without engine. The widgetId will be assigned automatically.

Parameters:

engineName - engine name to display in the label.

GPEngine

public GPEngine(String engineName,
        CustomEngine engine)

Constructor. The widgetId will be assigned automatically.

Parameters:

engineName - text to display in the label.

engine - default engine to set in the widget.

GPEngine

public GPEngine(String widgetId,
        String engineName)

Constructor.

Parameters:

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

engineName - text to display in the label.

GPEngine

public GPEngine(String widgetId,
        String label,
        CustomEngine engine)

Constructor.

Parameters:

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

label - text to display in the label.

engine - default engine to set in the widget.

Method Detail

getCount

public static int getCount()

Getter for the engines counter.

Returns:

the number of already created engines until now.

setCount

public static void setCount(int count)

Getter for the engines counter.

Parameters:

count - the number of already created engines until now.

getGLabel

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

Getter for the GLabel of the widget.

Returns:

the GLabel of the widget

getGEntryStingEngineName

public fr.cnes.genius.highLevel.GEntryString getGEntryStingEngineName()

Getter for the GEntryString (m_engineName) of the widget.

Returns:

the GEntryString of the widget

getGEntryRealIsp

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

Getter for the GEntryReal (m_isp) of the widget.

Returns:

the GEntryReal of the widget

getGEntryRealThrust

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

Getter for the GEntryReal (m_thrust) of the widget.

Returns:

the GEntryReal of the widget

setEngine

public void setEngine(CustomEngine engine)
               throws fr.cnes.genius.exception.GArithmeticException

Setter for the engine.

Parameters:

engine - engine to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if isp or thrust in engine are NaN.

setDefaultEngine

public void setDefaultEngine(CustomEngine defaultEngine)
                      throws fr.cnes.genius.exception.GArithmeticException

Setter for the default engine.

Parameters:

defaultEngine - default engine to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if isp or thrust in defaultEngine are NaN.

setSavedEngine

public void setSavedEngine(CustomEngine savedEngine)
                    throws fr.cnes.genius.exception.GArithmeticException

Setter for the reference engine.

Parameters:

savedEngine - reference engine to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if isp or thrust in savedEngine are NaN.

attachCopyPasteMenu

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

Overrides:

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

updateIsModifiedIndicator

public void updateIsModifiedIndicator()

Overrides:

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

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

isModified

public boolean isModified()

Overrides:

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

generic

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

Specified by:

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

Throws:

fr.cnes.genius.exception.GException

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

getEngineName

public String getEngineName()

Get engine name.

Returns:

the engine name

getPatriusObject

public CustomEngine getPatriusObject()

Get engine.

Specified by:

getPatriusObject in interface GPPatrius<CustomEngine>

Returns:

the engine

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

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

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

updateCondensedStatus

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

Specified by:

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

setWidgetId

public void setWidgetId(String widgetId)

Overrides:

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

clone

public GPEngine clone()
               throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

checkEngine

public static void checkEngine(CustomEngine engine)
                        throws fr.cnes.genius.exception.GArithmeticException

Checks if the thrust or the isp of the input engine are NaN.

Parameters:

engine - to be checked

Throws:

fr.cnes.genius.exception.GArithmeticException - if the thrust or the isp in engine are NaN.