fr.cnes.genopus.vehicle

Class GPRadiativeProperty

java.lang.Object

fr.cnes.genius.main.GComponent

fr.cnes.genius.lowLevel.GContainer

fr.cnes.genopus.vehicle.GPRadiativePropertyAbstract

fr.cnes.genopus.vehicle.GPRadiativeProperty

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

public class GPRadiativeProperty
extends GPRadiativePropertyAbstract
implements GPPatrius<fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty>

Widget representing a radiative property.

Author:

ffsm

Default Constraint(s):

Index	Class	Item	Constraint
0	GLabelWithIndicator	label	0, 0 => "newline , gapleft 0 , split 2" 0, 1 => (null)
1	GEntryReal	diffuseCoefEntryReal	1, 0, 0 => "newline , gapleft 20 , split 2" 1, 0, 1 => (null) 1, 1 => (null)
2	GEntryReal	specularCoefEntryReal	2, 0, 0 => "newline , gapleft 20 , split 2" 2, 0, 1 => (null) 2, 1 => (null)
3	GEntryReal	diffuseCoefEntryReal	3, 0, 0 => "newline , gapleft 20 , split 2" 3, 0, 1 => (null) 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

Field Summary

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

NAME_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
GPRadiativeProperty(String widgetId, String label) Creates a new instance.
GPRadiativeProperty(String widgetId, String label, fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
double	getAbsorptionRatio() Get absorption coefficient.
double	getDiffuseReflectionRatio() Get diffuse coefficient.
fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty	getPatriusObject() Returns the PATRIUS object associated to a GENOPUS widget.
double	getSpecularReflectionRatio() Get specular coefficient.
void	setDefaultValue(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty) Setter for the default radiative property.
void	setSavedValue(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty) Setter for the saved radiative property.
void	setValue(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty) Setter for the radiative property.

Methods inherited from class fr.cnes.genopus.vehicle.GPRadiativePropertyAbstract

after, attachCopyPasteMenu, before, clear, display, generic, getGEntryRealAbsCoeff, getGEntryRealDifCoeff, getGEntryRealSpcCoeff, getGLabel, getSubComponent, isEnabled, isModified, read, setConstraint, setDefaultConstraints, setDisplayIsModifiedIndicatorAll, setEnabled, setNameInConfigFile, setWidgetId, updateCondensedStatus, updateIsModifiedIndicator, updateStatus, 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, clearAllInnerDescendantConstraint, clearConstraint, clearInnerDescendantContraint, composeWidgetId, doDisplay, endOfElement, getCommentInConfigFile, getComponent, getConstraint, getCurrentOperation, getDisplayIndicatorStatus, getDisplayIsModifiedIndicator, getElement, getGClassName, getGPanel, getGParent, getGUnitInConfigFile, getInnerDescendantConstraint, getName, getNameInConfigFile, getOperationSaveValue, getPathInConfigFile, getSimpleWidgetId, getStatus, getStringConstraint, getWidgetId, handleCopyPasteEvent, handleCopyPasteEvent, handleProcessEventException, isCopyPasteEvent, isForcedStatus, launchInvalidPositionException, parseSimpleConstraint, processGEvent, setBusyCursor, setCommentInConfigFile, setConstraint, setCopyPasteMenuEnabled, setCurrentOperation, setDataForConstraintsByType, setDisplayIsModifiedIndicator, setElement, setForcedStatus, setGPanel, setGParent, setGUnitInConfigFile, setInnerDescendantConstraint, setNameAndCommentInConfigFile, 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

GPRadiativeProperty

public GPRadiativeProperty(String widgetId,
                   String label,
                   fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty)

Creates a new instance.

Parameters:

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

label - widget label

radiativeProperty - initial radiative property

GPRadiativeProperty

public GPRadiativeProperty(String widgetId,
                   String label)

Creates a new instance.

Parameters:

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

label - widget label

Method Detail

getPatriusObject

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

Returns the PATRIUS object associated to a GENOPUS widget.

Specified by:

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

Returns:

the PATRIUS object associated to the widget.

setValue

public void setValue(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty)
              throws fr.cnes.genius.exception.GArithmeticException

Setter for the radiative property.

Parameters:

radiativeProperty - radiative property

Throws:

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

setDefaultValue

public void setDefaultValue(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty)
                     throws fr.cnes.genius.exception.GArithmeticException

Setter for the default radiative property.

Parameters:

radiativeProperty - default radiative property.

Throws:

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

setSavedValue

public void setSavedValue(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty)
                   throws fr.cnes.genius.exception.GArithmeticException

Setter for the saved radiative property.

Parameters:

radiativeProperty - saved radiative property

Throws:

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

getAbsorptionRatio

public double getAbsorptionRatio()

Get absorption coefficient.

Returns:

the absorption coefficient.

getSpecularReflectionRatio

public double getSpecularReflectionRatio()

Get specular coefficient.

Returns:

the specular coefficient

getDiffuseReflectionRatio

public double getDiffuseReflectionRatio()

Get diffuse coefficient.

Returns:

the diffuse coefficient