fr.cnes.genopus.nonWidget.vehicle
Class CustomRadiativeProperties

java.lang.Object
  fr.cnes.genopus.nonWidget.vehicle.CustomRadiativeProperties

public class CustomRadiativeProperties
extends Object

Class to define vehicle radiative properties.

Author:

sumelzi

Constructor Summary

CustomRadiativeProperties(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty, fr.cnes.sirius.patrius.assembly.properties.RadiativeIRProperty radiativeIRProperty, CustomVehicleSurfaceModel vehicleSurfaceModel)
Creates a new instance with solar panels.

Method Summary

static boolean	coeffsSumOne(double ka, double ks, double kd) Function to check if the absortion, specular and difusse coefficients sum one.
fr.cnes.sirius.patrius.assembly.properties.RadiativeIRProperty	getRadiativeIRProperty() Get infrared radiative properties.
fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty	getRadiativeProperty() Get radiative properties.
CustomVehicleSurfaceModel	getVehicleSurfaceModel() Get vehicle surface model.
void	setRadiativeProperties(fr.cnes.sirius.patrius.assembly.AssemblyBuilder builder, String mainPartName, double multiplicativeFactor) Set radiative properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomRadiativeProperties

public CustomRadiativeProperties(fr.cnes.sirius.patrius.assembly.properties.RadiativeProperty radiativeProperty,
                                 fr.cnes.sirius.patrius.assembly.properties.RadiativeIRProperty radiativeIRProperty,
                                 CustomVehicleSurfaceModel vehicleSurfaceModel)

Creates a new instance with solar panels.

Parameters:

radiativeProperty - radiative property

radiativeIRProperty - infrared radiative property (it may be null if no infrared properties have to be considered)

vehicleSurfaceModel - vehicleSurfaceModel

Method Detail

setRadiativeProperties

public void setRadiativeProperties(fr.cnes.sirius.patrius.assembly.AssemblyBuilder builder,
                                   String mainPartName,
                                   double multiplicativeFactor)
                            throws NonWidgetException

Set radiative properties.

Parameters:

builder - the assembly builder

mainPartName - the main part name

multiplicativeFactor - multiplicative factor

Throws:

NonWidgetException - if shape type was wrongly defined

getRadiativeProperty

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

Get radiative properties.

Returns:

the radiativeProperty (null if they were not given)

getRadiativeIRProperty

public fr.cnes.sirius.patrius.assembly.properties.RadiativeIRProperty getRadiativeIRProperty()

Get infrared radiative properties.

Returns:

the radiativeIRProperty (null if they were not given)

getVehicleSurfaceModel

public CustomVehicleSurfaceModel getVehicleSurfaceModel()

Get vehicle surface model.

Returns:

the vehicleSurfaceModel

coeffsSumOne

public static boolean coeffsSumOne(double ka,
                                   double ks,
                                   double kd)

Function to check if the absortion, specular and difusse coefficients sum one.

Parameters:

ka - absortion coefficient

ks - specular coefficient

kd - diffuse coefficient

Returns:

true if they sum one, false otherwise.

toString

public String toString()

Overrides:

toString in class Object