fr.cnes.sirius.patrius.assembly.vehicle

Class RadiativeProperties

java.lang.Object

fr.cnes.sirius.patrius.assembly.vehicle.RadiativeProperties

All Implemented Interfaces:

Serializable

public class RadiativeProperties
extends Object
implements Serializable

Class to define vehicle radiative properties.

Since:

4.1

Version:

$Id$

Author:

Emmanuel Bignon

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RadiativeProperties(RadiativeProperty radiativePropertyIn, RadiativeIRProperty radiativeIRPropertyIn, VehicleSurfaceModel vehicleSurfaceModelIn) Constructor.

Method Summary

Modifier and Type	Method and Description
static boolean	coeffsSumOne(double ka, double ks, double kd) Function to check if the absortion, specular and difusse coefficients sum is one.
RadiativeIRProperty	getRadiativeIRProperty() Get infrared radiative properties.
RadiativeProperty	getRadiativeProperty() Get radiative properties.
VehicleSurfaceModel	getVehicleSurfaceModel() Get vehicle surface model.
void	setRadiativeProperties(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

RadiativeProperties

public RadiativeProperties(RadiativeProperty radiativePropertyIn,
                           RadiativeIRProperty radiativeIRPropertyIn,
                           VehicleSurfaceModel vehicleSurfaceModelIn)
                    throws PatriusException

Constructor.

Parameters:

radiativePropertyIn - radiative property

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

vehicleSurfaceModelIn - vehicleSurfaceModel

Throws:

PatriusException - thrown if the radiative property is null or radiative properties coefficient sum is not one

Method Detail

setRadiativeProperties

public void setRadiativeProperties(AssemblyBuilder builder,
                                   String mainPartName,
                                   double multiplicativeFactor)
                            throws PatriusException

Set radiative properties.

Parameters:

builder - the assembly builder

mainPartName - the main part name

multiplicativeFactor - multiplicative factor

Throws:

PatriusException - thrown if shape is not supported

getRadiativeProperty

public RadiativeProperty getRadiativeProperty()

Get radiative properties.

Returns:

the radiativeProperty (null if not provided)

getRadiativeIRProperty

public RadiativeIRProperty getRadiativeIRProperty()

Get infrared radiative properties.

Returns:

the radiativeIRProperty (null if not provided)

getVehicleSurfaceModel

public VehicleSurfaceModel 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 is 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