fr.cnes.genopus.vehicle

Class GPVehicleRadiativeProps

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.vehicle.GPVehicleRadiativeProps

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

public class GPVehicleRadiativeProps
extends fr.cnes.genius.lowLevel.GContainer
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, GPPatriusWithObjects<CustomRadiativeProperties>

Widget representing the vehicle radiative properties.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GPRadiativeProperty	radiativeProperty	"newline" (see table below)
1	GCheckBoxWithIndicator	infraPropCheckbox	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => (null)
2	GPRadiativeIRProperty	radiativeIRProperty	"newline" (see table below)

Default Constraint(s) for radiativeProperty:

Index	Class	Item	Constraint
0, 0	GLabelWithIndicator	label	0, 0, 0 => "newline , gapleft 20 , split 2" 0, 0, 1 => (null)
0, 1	GEntryReal	diffuseCoefEntryReal	0, 1, 0, 0 => "newline , gapleft 40 , split 2" 0, 1, 0, 1 => (null) 0, 1, 1 => (null)
0, 2	GEntryReal	specularCoefEntryReal	0, 2, 0, 0 => "newline , gapleft 40 , split 2" 0, 2, 0, 1 => (null) 0, 2, 1 => (null)
0, 3	GEntryReal	diffuseCoefEntryReal	0, 3, 0, 0 => "newline , gapleft 40 , split 2" 0, 3, 0, 1 => (null) 0, 3, 1 => (null)

Default Constraint(s) for radiativeIRProperty:

Index	Class	Item	Constraint
2, 0	GLabelWithIndicator	label	2, 0, 0 => "newline , gapleft 40 , split 2" 2, 0, 1 => (null)
2, 1	GEntryReal	diffuseCoefEntryReal	2, 1, 0, 0 => "newline , gapleft 60 , split 2" 2, 1, 0, 1 => (null) 2, 1, 1 => (null)
2, 2	GEntryReal	specularCoefEntryReal	2, 2, 0, 0 => "newline , gapleft 60 , split 2" 2, 2, 0, 1 => (null) 2, 2, 1 => (null)
2, 3	GEntryReal	diffuseCoefEntryReal	2, 3, 0, 0 => "newline , gapleft 60 , split 2" 2, 3, 0, 1 => (null) 2, 3, 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
GPVehicleRadiativeProps(String widgetId, String name) Creates a new instance.

Method Summary

Methods

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()
fr.cnes.genius.highLevel.GCheckBoxWithIndicator	getGCheckBoxIRCoeffs() Getter for the checkbox for the coefficients of the infrared domain.
GPRadiativeIRProperty	getGPRadiativeIRProperty() Getter for the radiative property (infrared domain).
GPRadiativeProperty	getGPRadiativeProperty() Getter for the radiative property (visible domain).
CustomRadiativeProperties	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
CustomRadiativeProperties	getPatriusObject(Object... args) Returns the PATRIUS object associated to a GENOPUS widget.
fr.cnes.genius.main.GComponent	getSubComponent(int position)
CustomVehicleSurfaceModel	getSurfaceModel() Method to get the vehicle surface model that will allow to get the radiative properties.
boolean	hasIRProps() Method to check if the vehicle has solar panels defined.
boolean	isEnabled()
boolean	isModified()
void	read()
void	setConstraint(int widgetGap) Setter for the constraints of the widget.
void	setDefaultRadiativeProperties(CustomRadiativeProperties radiativeProperties) Setter for the default radiative properties.
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	setRadiativeProperties(CustomRadiativeProperties radiativeProperties) Setter for the radiative properties.
void	setSavedRadiativeProperties(CustomRadiativeProperties radiativeProperties) Setter for the saved radiative properties.
void	setSurfaceModel(CustomVehicleSurfaceModel vehicleSurfaceModel) Method to set the vehicle surface model that will allow to get the radiative properties.
void	setWidgetId(String widgetId)
void	updateCondensedStatus(fr.cnes.genius.main.GCondensedStatus condensedStatus)
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, 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, 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

GPVehicleRadiativeProps

public GPVehicleRadiativeProps(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

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.

setSurfaceModel

public void setSurfaceModel(CustomVehicleSurfaceModel vehicleSurfaceModel)

Method to set the vehicle surface model that will allow to get the radiative properties. It is mandatory to call this method just before calling getPatriusObject() method.

Parameters:

vehicleSurfaceModel - vehicle surface model.

getSurfaceModel

public CustomVehicleSurfaceModel getSurfaceModel()

Method to get the vehicle surface model that will allow to get the radiative properties.

Returns:

vehicle surface model.

getGPRadiativeProperty

public GPRadiativeProperty getGPRadiativeProperty()

Getter for the radiative property (visible domain).

Returns:

the radiative property (visible domain)

getGCheckBoxIRCoeffs

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

Getter for the checkbox for the coefficients of the infrared domain.

Returns:

the checkbox for the coefficients of the infrared domain.

getGPRadiativeIRProperty

public GPRadiativeIRProperty getGPRadiativeIRProperty()

Getter for the radiative property (infrared domain).

Returns:

the radiative property (infrared domain).

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

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

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

getPatriusObject

public CustomRadiativeProperties getPatriusObject()
                                           throws GPVehicleException

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatrius<CustomRadiativeProperties>

Returns:

the PATRIUS object associated to the widget.

Throws:

GPVehicleException - if the surface model is null

getPatriusObject

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

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

getPatriusObject in interface GPPatriusWithObjects<CustomRadiativeProperties>

Parameters:

args - requiered input objects to generate the patrius object.

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.

hasIRProps

public boolean hasIRProps()

Method to check if the vehicle has solar panels defined.

Returns:

true if the vehicle has solar panels

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

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.

updateIsModifiedIndicator

protected void updateIsModifiedIndicator()

Overrides:

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

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

setRadiativeProperties

public void setRadiativeProperties(CustomRadiativeProperties radiativeProperties)
                            throws fr.cnes.genius.exception.GArithmeticException

Setter for the radiative properties.

Parameters:

radiativeProperties - the radiative properties.

Throws:

fr.cnes.genius.exception.GArithmeticException - if any of the radiative coefficients in radiativeProperty is NaN.

setDefaultRadiativeProperties

public void setDefaultRadiativeProperties(CustomRadiativeProperties radiativeProperties)
                                   throws fr.cnes.genius.exception.GArithmeticException

Setter for the default radiative properties.

Parameters:

radiativeProperties - the default radiative properties.

Throws:

fr.cnes.genius.exception.GArithmeticException - if any of the radiative coefficients in radiativeProperty is NaN.

setSavedRadiativeProperties

public void setSavedRadiativeProperties(CustomRadiativeProperties radiativeProperties)
                                 throws fr.cnes.genius.exception.GArithmeticException

Setter for the saved radiative properties.

Parameters:

radiativeProperties - the saved radiative properties.

Throws:

fr.cnes.genius.exception.GArithmeticException - if any of the radiative coefficients in radiativeProperty is NaN.