fr.cnes.sirius.patrius.assembly.properties
Class RadiativeIRProperty

java.lang.Object
  fr.cnes.sirius.patrius.assembly.properties.RadiativeIRProperty

All Implemented Interfaces:

IPartProperty

public final class RadiativeIRProperty
extends Object
implements IPartProperty

This class is a part property for the PATRIUS assembly. It is the radiative property of a part. Three optical coefficients are defined in the infrared domain.

Since:

1.1

Version:

$Id: RadiativeIRProperty.java 13514 2015-06-11 15:13:12Z maggiorani $

Author:

Gerald Mercadier

Concurrency :

immutable

Field Summary

static String	ABSORPTION_COEFFICIENT Parameter name for absorption coefficient.
static String	DIFFUSION_COEFFICIENT Parameter name for diffusion coefficient.
static String	SPECULAR_COEFFICIENT Parameter name for reflection coefficient.

Constructor Summary

RadiativeIRProperty(double absorptionCoef, double specularCoef, double diffuseCoef)
Constructor of this property.

RadiativeIRProperty(Parameter absorptionCoef, Parameter specularCoef, Parameter diffuseCoef)
Constructor of this property using Parameter.

Method Summary

Parameter	getAbsorptionCoef() Get the parameter representing the absorption coefficient of the part.
Parameter	getDiffuseReflectionCoef() Get the parameter representing the diffuse reflection coefficient of the part.
Parameter	getSpecularReflectionCoef() Get the parameter representing the specular reflection coefficient of the part.
PropertyType	getType() Get the type of the property.

Methods inherited from class java.lang.Object

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

Field Detail

ABSORPTION_COEFFICIENT

public static final String ABSORPTION_COEFFICIENT

Parameter name for absorption coefficient.

See Also:

Constant Field Values

SPECULAR_COEFFICIENT

public static final String SPECULAR_COEFFICIENT

Parameter name for reflection coefficient.

See Also:

Constant Field Values

DIFFUSION_COEFFICIENT

public static final String DIFFUSION_COEFFICIENT

Parameter name for diffusion coefficient.

See Also:

Constant Field Values

Constructor Detail

RadiativeIRProperty

public RadiativeIRProperty(double absorptionCoef,
                           double specularCoef,
                           double diffuseCoef)

Constructor of this property.

Parameters:

absorptionCoef - The absorption coefficient of the part.

specularCoef - The specular reflection coefficient of the part.

diffuseCoef - The diffuse reflection coefficient of the part.

RadiativeIRProperty

public RadiativeIRProperty(Parameter absorptionCoef,
                           Parameter specularCoef,
                           Parameter diffuseCoef)

Constructor of this property using Parameter.

Parameters:

absorptionCoef - The parameter representing the absorption coefficient of the part.

specularCoef - The parameter representing the specular reflection coefficient of the part.

diffuseCoef - The parameter representing the diffuse reflection coefficient of the part.

Method Detail

getAbsorptionCoef

public Parameter getAbsorptionCoef()

Get the parameter representing the absorption coefficient of the part.

Returns:

the parameter representing the absorption coefficient

getSpecularReflectionCoef

public Parameter getSpecularReflectionCoef()

Get the parameter representing the specular reflection coefficient of the part.

Returns:

the parameter representing the specular reflection coefficient

getDiffuseReflectionCoef

public Parameter getDiffuseReflectionCoef()

Get the parameter representing the diffuse reflection coefficient of the part.

Returns:

the parameter representing the diffuse reflection coefficient

getType

public PropertyType getType()

Description copied from interface: IPartProperty

Get the type of the property.

Specified by:

getType in interface IPartProperty

Returns:

the type of the property (see PropertyType enumeration)