fr.cnes.sirius.patrius.assembly.properties

Class PropulsiveProperty

java.lang.Object

fr.cnes.sirius.patrius.assembly.properties.PropulsiveProperty

All Implemented Interfaces:

IPartProperty, Serializable

public final class PropulsiveProperty
extends Object
implements IPartProperty, Serializable

Propulsive property : gathers all thrust properties.

Since:

3.4

Version:

$Id$

Author:

rodriguest

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
PropulsiveProperty(double inThrust, double inIsp) Constructor for the property with constant value for thrust and isp.
PropulsiveProperty(IDependentVariable<SpacecraftState> inThrust, IDependentVariable<SpacecraftState> inIsp) Constructor for the property with thrust and isp as IDependentVariable.
PropulsiveProperty(Parameter inThrust, Parameter inIsp) Constructor for the property with thrust and isp as Parameter.
PropulsiveProperty(PropulsiveProperty propulsivePropertyIn) Copy constructor.

Method Summary

Modifier and Type	Method and Description
IDependentVariable<SpacecraftState>	getIsp() Getter for the isp as an IDependentVariable object.
double	getIsp(SpacecraftState state) Getter for isp (s) as function of input SpacecraftState.
Parameter	getIspParam() Getter for the isp as an Parameter object.
String	getPartName() Getter for the part name owning the property.
IDependentVariable<SpacecraftState>	getThrust() Getter for the thrust as an IDependentVariable object.
double	getThrust(SpacecraftState state) Getter for thrust force (N) as function of input SpacecraftState.
Parameter	getThrustParam() Getter for the thrust force as an Parameter object.
PropertyType	getType() Get the type of the property.
void	setPartName(String nameIn) Setter for the part name owning the property.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropulsiveProperty

public PropulsiveProperty(Parameter inThrust,
                          Parameter inIsp)

Constructor for the property with thrust and isp as Parameter.

Parameters:

inThrust - thrust

inIsp - isp

PropulsiveProperty

public PropulsiveProperty(double inThrust,
                          double inIsp)

Constructor for the property with constant value for thrust and isp.

Parameters:

inThrust - thrust

inIsp - isp

PropulsiveProperty

public PropulsiveProperty(IDependentVariable<SpacecraftState> inThrust,
                          IDependentVariable<SpacecraftState> inIsp)

Constructor for the property with thrust and isp as IDependentVariable.

Parameters:

inThrust - thrust

inIsp - isp

PropulsiveProperty

public PropulsiveProperty(PropulsiveProperty propulsivePropertyIn)

Copy constructor.

Parameters:

propulsivePropertyIn - propulsive property

Method Detail

setPartName

public void setPartName(String nameIn)

Setter for the part name owning the property. Warning: this setter should not be used. It is used internally in PATRIUS.

Parameters:

nameIn - the part name owning the property

getPartName

public String getPartName()

Getter for the part name owning the property.

Returns:

the part name owning the property

getThrust

public IDependentVariable<SpacecraftState> getThrust()

Getter for the thrust as an IDependentVariable object.

Returns:

the thrust

getIsp

public IDependentVariable<SpacecraftState> getIsp()

Getter for the isp as an IDependentVariable object.

Returns:

the isp

getIspParam

public Parameter getIspParam()

Getter for the isp as an Parameter object.

Will return NaN if ISP has been defined as variable.

Returns:

the isp

getThrustParam

public Parameter getThrustParam()

Getter for the thrust force as an Parameter object.

Will return NaN if thrust has been defined as variable.

Returns:

the thrust force

getThrust

public double getThrust(SpacecraftState state)

Getter for thrust force (N) as function of input SpacecraftState.

Parameters:

state - the spacecraft state

Returns:

the thrust (N)

getIsp

public double getIsp(SpacecraftState state)

Getter for isp (s) as function of input SpacecraftState.

Parameters:

state - the spacecraft state

Returns:

the isp (s)

getType

public PropertyType getType()

Get the type of the property.

Specified by:

getType in interface IPartProperty

Returns:

the type of the property (see PropertyType enumeration)

toString

public String toString()

Overrides:

toString in class Object