fr.cnes.genopus.vehicle

Class GPVehiclePropulsiveProps

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GPanel

fr.cnes.genopus.vehicle.GPVehiclePropulsiveProps

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, MouseWheelListener, EventListener

public class GPVehiclePropulsiveProps
extends fr.cnes.genius.lowLevel.GPanel
implements fr.cnes.genius.main.GReadWrite, fr.cnes.genius.main.GListener, fr.cnes.genius.main.GDisplay, fr.cnes.genius.main.GClear, fr.cnes.genius.main.GCondensedStatusInterface

Widget representing a vehicle propulsive properties (list of tanks and engines).

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GEntryReal	ergMassEntryReal	0, 0, 0 => "newline , gapleft 20 , split 2" 0, 0, 1 => (null) 0, 1 => (null) 0, 2 => (null)
1	GSeparator	enginesSeparator	"newline , gapleft 20 , spanx 4 , growx"
2	GOpenCloseButton	enginesOpenCloseButton	"newline , gapleft 0 , split 2"
3	GLabelWithIndicator	enginesLabel	3, 0 => (null) 3, 1 => (null)
4	GComponentList	enginesList	"newline , gapleft 20 , spanx 4 , growx" (see table below)
5	GSeparator	tanksSeparator	"newline , gapleft 20 , spanx 4 , growx"
6	GOpenCloseButton	tanksOpenCloseButton	"newline , gapleft 0 , split 2"
7	GLabelWithIndicator	tanksLabel	7, 0 => (null) 7, 1 => (null)
8	GComponentList	tanksList	"newline , gapleft 20 , spanx 4 , growx" (see table below)

Default Constraint(s) for enginesList:

Index	Class	Item	Constraint
4, 0	GHeaderPanel	header	"hmin 40" (see table below)
4, 1	GLabel	spaceLabel	"newline , height 0"

Default Constraint(s) for header:

Index	Class	Item	Constraint
4, 0, 0	GEntryInt	totalNumberItemsEntry	4, 0, 0, 0, 0 => "newline , split 2" 4, 0, 0, 0, 1 => (null) 4, 0, 0, 1 => "skip 2 , width 50"
4, 0, 1	GEntryInt	currentItemRankEntry	4, 0, 1, 0, 0 => "split 2" 4, 0, 1, 0, 1 => (null) 4, 0, 1, 1 => "width 50"
4, 0, 2	GButton	decrButton	"alignx Right , height 20"
4, 0, 3	GButton	incrButton	"height 20"
4, 0, 4	GPopupList	menu	(null)

Default Constraint(s) for tanksList:

Index	Class	Item	Constraint
8, 0	GHeaderPanel	header	"hmin 40" (see table below)
8, 1	GLabel	spaceLabel	"newline , height 0"

Default Constraint(s) for header:

Index	Class	Item	Constraint
8, 0, 0	GEntryInt	totalNumberItemsEntry	8, 0, 0, 0, 0 => "newline , split 2" 8, 0, 0, 0, 1 => (null) 8, 0, 0, 1 => "skip 2 , width 50"
8, 0, 1	GEntryInt	currentItemRankEntry	8, 0, 1, 0, 0 => "split 2" 8, 0, 1, 0, 1 => (null) 8, 0, 1, 1 => "width 50"
8, 0, 2	GButton	decrButton	"alignx Right , height 20"
8, 0, 3	GButton	incrButton	"height 20"
8, 0, 4	GPopupList	menu	(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
GPVehiclePropulsiveProps() Creates a new instance with empty label.
GPVehiclePropulsiveProps(String widgetId, String name) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	after(fr.cnes.genius.main.GEvent e)
void	before(fr.cnes.genius.main.GEvent e)
void	clear()
void	display()
void	generic()
String[]	getEngineNames() Method to get the list of engine names.
ArrayList<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty>	getEnginesList() Get list of engines.
double	getErgMass() Get ergol mass.
fr.cnes.genius.highLevel.GComponentList	getGComponentListEngines() Getter for the list of engines.
fr.cnes.genius.highLevel.GComponentList	getGComponentListTanks() Getter for the list of tanks.
fr.cnes.genius.highLevel.GEntryReal	getGEntryRealErgMass() Getter for the entry real with the mass of ergols.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabelEngines() Getter for the label for the engines.
fr.cnes.genius.highLevel.GLabelWithIndicator	getGLabelTanks() Getter for the label for the tanks.
fr.cnes.genius.highLevel.GOpenCloseButton	getGOpenCloseButtonEngines() Getter for the open close button for the engines.
fr.cnes.genius.highLevel.GOpenCloseButton	getGOpenCloseButtonTanks() Getter for the open close button for the tanks.
fr.cnes.genius.lowLevel.GSeparator	getGSeparatorEngines() Getter for the separator for the engines.
fr.cnes.genius.lowLevel.GSeparator	getGSeparatorTanks() Getter for the separator for the tanks.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
String[]	getTankNames() Method to get the list of tank names.
ArrayList<fr.cnes.sirius.patrius.assembly.properties.TankProperty>	getTanksList() Get list of tanks.
boolean	isEnabled()
boolean	isModified()
void	read()
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setDefaultConstraints() Setter for the default constraint of the widget.
void	setDefaultEnginesList(List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> enginesList) Setter for the default list of engines.
void	setDefaultTanksList(List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> tanksList) Setter for the default list of fuel tanks.
void	setDisplayIsModifiedIndicatorAll(fr.cnes.genius.main.GComponent.DisplayIndicatorStatus displayIndicatorStatus) Controls the display of the isModified indicator of all sub-widgets.
void	setEnabled(boolean b)
void	setEnginesList(List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> enginesList) Setter for the list of engines.
void	setSavedEnginesList(List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> enginesList) Setter for the saved list of engines.
void	setSavedTanksList(List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> tanksList) Setter for the saved list of tanks.
void	setTanksList(List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> tanksList) Setter for the list of fuel tanks.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
protected void	updateEnginesIsModifiedIndicator() Update the engines label modified indicator depending on the engines list modified status.
protected void	updateTanksIsModifiedIndicator() Update the tanks label modified indicator depending on the tanks list modified status.
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, 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, updateIsModifiedIndicator, 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

GPVehiclePropulsiveProps

public GPVehiclePropulsiveProps()

Creates a new instance with empty label. The widgetId will be assigned automatically.

GPVehiclePropulsiveProps

public GPVehiclePropulsiveProps(String widgetId,
                                String name)

Creates a new instance.

Parameters:

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

name - name in configuration file

Method Detail

setWidgetId

public void setWidgetId(String widgetId)

Overrides:

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

setDefaultConstraints

public void setDefaultConstraints()

Setter for the default constraint of the widget.

Overrides:

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

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.

getGEntryRealErgMass

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

Getter for the entry real with the mass of ergols.

Returns:

the entry real with the mass of ergols.

getGSeparatorEngines

public fr.cnes.genius.lowLevel.GSeparator getGSeparatorEngines()

Getter for the separator for the engines.

Returns:

the separator for the engines.

getGLabelEngines

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

Getter for the label for the engines.

Returns:

the label for the engines.

getGOpenCloseButtonEngines

public fr.cnes.genius.highLevel.GOpenCloseButton getGOpenCloseButtonEngines()

Getter for the open close button for the engines.

Returns:

the open close button for the engines.

getGComponentListEngines

public fr.cnes.genius.highLevel.GComponentList getGComponentListEngines()

Getter for the list of engines.

Returns:

the list of engines.

getGSeparatorTanks

public fr.cnes.genius.lowLevel.GSeparator getGSeparatorTanks()

Getter for the separator for the tanks.

Returns:

the separator for the tanks.

getGLabelTanks

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

Getter for the label for the tanks.

Returns:

the label for the tanks.

getGOpenCloseButtonTanks

public fr.cnes.genius.highLevel.GOpenCloseButton getGOpenCloseButtonTanks()

Getter for the open close button for the tanks.

Returns:

the open close button for the tanks.

getGComponentListTanks

public fr.cnes.genius.highLevel.GComponentList getGComponentListTanks()

Getter for the list of tanks.

Returns:

the list of tanks.

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

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

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

getEngineNames

public String[] getEngineNames()

Method to get the list of engine names.

Returns:

list of engine names

getTankNames

public String[] getTankNames()

Method to get the list of tank names.

Returns:

list of tank names

getTanksList

public ArrayList<fr.cnes.sirius.patrius.assembly.properties.TankProperty> getTanksList()

Get list of tanks.

Returns:

list of tanks.

getEnginesList

public ArrayList<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> getEnginesList()

Get list of engines.

Returns:

list of engines.

getErgMass

public double getErgMass()

Get ergol mass.

Returns:

the ergMass

updateCondensedStatus

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

Specified by:

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

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

updateTanksIsModifiedIndicator

protected void updateTanksIsModifiedIndicator()

Update the tanks label modified indicator depending on the tanks list modified status.

updateEnginesIsModifiedIndicator

protected void updateEnginesIsModifiedIndicator()

Update the engines label modified indicator depending on the engines list modified status.

setDisplayIsModifiedIndicatorAll

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

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

Parameters:

displayIndicatorStatus - if Always the modifiedStatusIndicator is always shown, if Never the modifiedStatusIndicator is never shown, if Automatic the modifiedStatusIndicator is shown as needed.

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

setEnginesList

public void setEnginesList(List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> enginesList)
                    throws GPVehicleException,
                           fr.cnes.genius.exception.GArithmeticException

Setter for the list of engines.

Parameters:

enginesList - the list of engines

Throws:

GPVehicleException - if the list of tanks is not coherent with the max and min of the list of engines.

fr.cnes.genius.exception.GArithmeticException - if any engine in the list has NaN thrust or isp.

setTanksList

public void setTanksList(List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> tanksList)
                  throws GPVehicleException,
                         fr.cnes.genius.exception.GArithmeticException

Setter for the list of fuel tanks.

Parameters:

tanksList - the list of fuel tanks

Throws:

GPVehicleException - if the list of tanks is not coherent with the max and min of the list of tanks.

fr.cnes.genius.exception.GArithmeticException - if any tank in the list has NaN propellant mass.

setDefaultEnginesList

public void setDefaultEnginesList(List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> enginesList)
                           throws fr.cnes.genius.exception.GArithmeticException

Setter for the default list of engines.

Parameters:

enginesList - the default list of engines

Throws:

fr.cnes.genius.exception.GArithmeticException - if any engine in the list has NaN thrust or isp.

setDefaultTanksList

public void setDefaultTanksList(List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> tanksList)
                         throws fr.cnes.genius.exception.GArithmeticException

Setter for the default list of fuel tanks.

Parameters:

tanksList - the default list of fuel tanks

Throws:

fr.cnes.genius.exception.GArithmeticException - if any tank in the list has NaN propellant mass.

setSavedEnginesList

public void setSavedEnginesList(List<fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty> enginesList)
                         throws fr.cnes.genius.exception.GArithmeticException

Setter for the saved list of engines.

Parameters:

enginesList - the saved list of engines

Throws:

fr.cnes.genius.exception.GArithmeticException - if any of the engines in enginesList has NaN isp or thrust.

fr.cnes.genius.exception.GArithmeticException - if any engine in the list has NaN thrust or isp.

setSavedTanksList

public void setSavedTanksList(List<fr.cnes.sirius.patrius.assembly.properties.TankProperty> tanksList)
                       throws fr.cnes.genius.exception.GArithmeticException

Setter for the saved list of tanks.

Parameters:

tanksList - the saved list of tanks

Throws:

fr.cnes.genius.exception.GArithmeticException - if any of the tanks in tanksList has NaN propellant mass.

fr.cnes.genius.exception.GArithmeticException - if any tank in the list has NaN propellant mass.