fr.cnes.sirius.patrius.assembly.vehicle

Class VehicleSurfaceModel

java.lang.Object

fr.cnes.sirius.patrius.assembly.vehicle.VehicleSurfaceModel

All Implemented Interfaces:

CrossSectionProvider, Serializable

public class VehicleSurfaceModel
extends Object
implements CrossSectionProvider, Serializable

Vehicle surface model class. It defines a derivative function parameterizable where the variable is the spacecraft state and the function is the cross section surface (including solar panels) as seen from the velocity vector direction. It includes a multiplicative factor as a parameter.

Since:

4.1

Version:

$Id$

Author:

Emmanuel Bignon

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	MULTIPLICATIVE_FACTOR Multiplicative factor parameter name.

Constructor Summary

Constructors

Constructor and Description
VehicleSurfaceModel(CrossSectionProvider vehicleShape) Constructor without solar panels and with default multiplicative factor set to 1.0.
VehicleSurfaceModel(CrossSectionProvider vehicleShape, RightParallelepiped solarPanels) Constructor with default multiplicative factor set to 1.0.
VehicleSurfaceModel(CrossSectionProvider mainPart, RightParallelepiped solarPanels, double multiplicativeFactorIn) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object other)
double	getCrossSection(Vector3D direction) Computes the cross section from the direction defined by a Vector3D.
CrossSectionProvider	getMainPartShape() Get the main part vehicle shape.
Parameter	getMultiplicativeFactor() Get the multiplicative factor applied to the reference surface as a parameter.
RightParallelepiped	getSolarPanelsShape() Get solar panels.
int	hashCode()
void	setMultiplicativeFactor(double multiplicativeFactorIn) Set the multiplicative factor applied to the reference surface.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MULTIPLICATIVE_FACTOR

public static final String MULTIPLICATIVE_FACTOR

Multiplicative factor parameter name.

See Also:

Constant Field Values

Constructor Detail

VehicleSurfaceModel

public VehicleSurfaceModel(CrossSectionProvider vehicleShape)
                    throws PatriusException

Constructor without solar panels and with default multiplicative factor set to 1.0.

Parameters:

vehicleShape - main part shape (cannot be null)

Throws:

PatriusException - thrown if main part is null

VehicleSurfaceModel

public VehicleSurfaceModel(CrossSectionProvider vehicleShape,
                           RightParallelepiped solarPanels)
                    throws PatriusException

Constructor with default multiplicative factor set to 1.0.

Parameters:

vehicleShape - main part shape (cannot be null)

solarPanels - solar panels shape (it may be null)

Throws:

PatriusException - thrown if main part is null

VehicleSurfaceModel

public VehicleSurfaceModel(CrossSectionProvider mainPart,
                           RightParallelepiped solarPanels,
                           double multiplicativeFactorIn)
                    throws PatriusException

Constructor.

Parameters:

mainPart - main part shape (cannot be null)

solarPanels - solar panels shape (it may be null)

multiplicativeFactorIn - multiplicative factor for the total vehicle surface

Throws:

PatriusException - thrown if main part is null

Method Detail

getCrossSection

public double getCrossSection(Vector3D direction)

Computes the cross section from the direction defined by a Vector3D.

Specified by:

getCrossSection in interface CrossSectionProvider

Parameters:

direction - the direction vector

Returns:

the cross section

getMultiplicativeFactor

public Parameter getMultiplicativeFactor()

Get the multiplicative factor applied to the reference surface as a parameter.

Returns:

the multiplicative factor parameter

setMultiplicativeFactor

public void setMultiplicativeFactor(double multiplicativeFactorIn)

Set the multiplicative factor applied to the reference surface.

Parameters:

multiplicativeFactorIn - the multiplicative factor

getMainPartShape

public CrossSectionProvider getMainPartShape()

Get the main part vehicle shape.

Returns:

the shape

getSolarPanelsShape

public RightParallelepiped getSolarPanelsShape()

Get solar panels. If no solar panels are defined, null is returned.

Returns:

the solar panels

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object