fr.cnes.sirius.patrius.assembly.properties

Class TankProperty

java.lang.Object

fr.cnes.sirius.patrius.math.parameter.Parameterizable

fr.cnes.sirius.patrius.assembly.properties.TankProperty

All Implemented Interfaces:

IPartProperty, IParameterizable, Serializable

public final class TankProperty
extends Parameterizable
implements IPartProperty

Tank property: gathers all properties of a fuel tank.

Warning: a part should either have a MassProperty or a TankProperty, never both

Since:

3.4

Version:

$Id$

Author:

Emmanuel Bignon

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

Constructors

Constructor and Description
TankProperty(double massIn) Constructor.
TankProperty(TankProperty tankPropertyIn) Copy constructor.

Method Summary

Modifier and Type	Method and Description
double	getMass() Getter for the mass.
MassProperty	getMassProperty() Getter for the underlying mass property.
String	getPartName() Getter for the part name owning the property.
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 fr.cnes.sirius.patrius.math.parameter.Parameterizable

addParameter, getParameters, supportsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

TankProperty

public TankProperty(double massIn)
             throws PatriusException

Constructor.

Parameters:

massIn - mass

Throws:

PatriusException - thrown if mass is negative

TankProperty

public TankProperty(TankProperty tankPropertyIn)

Copy constructor.

Parameters:

tankPropertyIn - tank 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

getMass

public double getMass()

Getter for the mass.

Returns:

tank mass

getMassProperty

public MassProperty getMassProperty()

Getter for the underlying mass property.

Returns:

the underlying mass property

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