fr.cnes.genopus.maneuvers

Class GPFuelTank

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genopus.maneuvers.GPFuelTank

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<fr.cnes.sirius.patrius.assembly.properties.TankProperty>, MouseWheelListener, Cloneable, EventListener

public class GPFuelTank
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<fr.cnes.sirius.patrius.assembly.properties.TankProperty>

Widget for fuel tank definition.

Author:

sumelzi, bacr

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0" 0, 1 => (null)
1	GEntryString	entryStringTankName	1, 0, 0 => "newline , gapleft 20" 1, 0, 1 => (null) 1, 1 => (null)
2	GEntryReal	entryRealPropMass	2, 0, 0 => "newline , gapleft 20" 2, 0, 1 => (null) 2, 1 => (null) 2, 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
GPFuelTank() Default constructor
GPFuelTank(String label) Constructor without tank.
GPFuelTank(String widgetId, String label) Constructor.
GPFuelTank(String widgetId, String label, String tankName, fr.cnes.sirius.patrius.assembly.properties.TankProperty tank) Constructor.
GPFuelTank(String label, String tankName, fr.cnes.sirius.patrius.assembly.properties.TankProperty tank) Constructor.

Method Summary

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	checkTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty tank) Checks if the the propellant mass in the input tank is NaN.
void	clear()
GPFuelTank	clone()
void	display()
void	generic()
static int	getCount() Getter for the tanks counter.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealPropellantMass() Getter for the GEntryReal (m_propellantMass) of the widget.
fr.cnes.genius.highLevel.GEntryString	getGEntryStingTankName() Getter for the GEntryString (m_tankName) of the widget.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabel() Getter for the GLabel of the widget.
String	getLabel() Get tank label
fr.cnes.sirius.patrius.assembly.properties.TankProperty	getPatriusObject() Get tank.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
String	getTankName() Get tank name.
boolean	isEnabled()
boolean	isModified()
void	read()
static void	setCount(int count) Getter for the tanks counter.
void	setDefaultConstraints() Setter for the default constraint of the widget.
void	setDefaultTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty defaultTank) Setter for the default tank.
void	setEnabled(boolean b)
void	setSavedTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty savedTank) Setter for the reference tank.
void	setTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty tank) Setter for the tank.
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

clearConstraint, getClassConstraint, getComponent, getHorizontalScroll, getInnerDescendantClassConstraint, getJPanel, getJScrollPane, getLayoutConstraints, getStringClassConstraint, getVerticalScroll, mainClear, mainDisplay, processMouseWheelEvent, put, setClassConstraint, setColumnConstraints, setConstraint, setHorizontalScroll, setInnerDescendantClassConstraint, setLayoutConstraints, setMargins, setPanelConstraints, setPreferredSize, setRowConstraints, setUnitIncrement, setVerticalScroll, unput

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

activateConstraintsByType, attachCopyPasteMenu, beginOfElement, beginOfElement, beginOfElement, beginOfElement, clearAllInnerDescendantConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, 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, setBusyCursor, setCommentInConfigFile, 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

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

Constructor Detail

GPFuelTank

public GPFuelTank()

Default constructor

GPFuelTank

public GPFuelTank(String label)

Constructor without tank. The widgetId will be assigned automatically.

Parameters:

label - text to display in the label.

GPFuelTank

public GPFuelTank(String label,
                  String tankName,
                  fr.cnes.sirius.patrius.assembly.properties.TankProperty tank)

Constructor.

Parameters:

label - text to display in the label.

tankName - name of the tank

tank - default tank to set in the widget.

GPFuelTank

public GPFuelTank(String widgetId,
                  String label)

Constructor.

Parameters:

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

label - text to display in the label.

GPFuelTank

public GPFuelTank(String widgetId,
                  String label,
                  String tankName,
                  fr.cnes.sirius.patrius.assembly.properties.TankProperty tank)

Constructor.

Parameters:

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

label - text to display in the label.

tankName - name of the tank

tank - default tank to set in the widget.

Method Detail

getCount

public static int getCount()

Getter for the tanks counter.

Returns:

the number of already created tanks until now.

setCount

public static void setCount(int count)

Getter for the tanks counter.

Parameters:

count - the number of already created tanks until now.

getGLabel

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

Getter for the GLabel of the widget.

Returns:

the GLabel of the widget

getGEntryStingTankName

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

Getter for the GEntryString (m_tankName) of the widget.

Returns:

the GEntryString of the widget

getGEntryRealPropellantMass

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

Getter for the GEntryReal (m_propellantMass) of the widget.

Returns:

the GEntryReal of the widget

setTank

public void setTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty tank)
             throws fr.cnes.genius.exception.GArithmeticException

Setter for the tank.

Parameters:

tank - tank to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if propellant mass in tank is NaN.

setDefaultTank

public void setDefaultTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty defaultTank)
                    throws fr.cnes.genius.exception.GArithmeticException

Setter for the default tank.

Parameters:

defaultTank - default tank to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if propellant mass in defaultTank is NaN.

setSavedTank

public void setSavedTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty savedTank)
                  throws fr.cnes.genius.exception.GArithmeticException

Setter for the reference tank.

Parameters:

savedTank - reference tank to set.

Throws:

fr.cnes.genius.exception.GArithmeticException - if propellant mass in savedTank is 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

getTankName

public String getTankName()

Get tank name.

Returns:

the tank name

getLabel

public String getLabel()

Get tank label

Returns:

label

getPatriusObject

public fr.cnes.sirius.patrius.assembly.properties.TankProperty getPatriusObject()

Get tank.

Specified by:

getPatriusObject in interface GPPatrius<fr.cnes.sirius.patrius.assembly.properties.TankProperty>

Returns:

the tank

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

setDefaultConstraints

public void setDefaultConstraints()

Setter for the default constraint of the widget.

Overrides:

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

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 GPFuelTank clone()
                 throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException

checkTank

public static void checkTank(fr.cnes.sirius.patrius.assembly.properties.TankProperty tank)
                      throws fr.cnes.genius.exception.GArithmeticException

Checks if the the propellant mass in the input tank is NaN.

Parameters:

tank - to be checked

Throws:

fr.cnes.genius.exception.GArithmeticException - if the propellant mass in tank is NaN.