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

java.lang.Object
  org.orekit.parameter.Parameterizable
      fr.cnes.sirius.patrius.assembly.properties.MassProperty

All Implemented Interfaces:

IPartProperty, Serializable, IParameterizable

public final class MassProperty
extends Parameterizable
implements IPartProperty

This class is a part property for the PATRIUS assembly. It is the mass property of a part.

Since:

1.1

Version:

$Id: MassProperty.java 17588 2017-05-10 13:31:54Z bignon $

Author:

Gerald Mercadier

See Also:

Serialized Form

Concurrency :

immutable

Constructor Summary

MassProperty(double inMass)
Constructor of this property.

MassProperty(Parameter inMass)
Constructor of this property using a Parameter.

Method Summary

double	getMass() Gets the mass of the part.
PropertyType	getType() Get the type of the property.
void	updateMass(double newMass) Updates the mass of the part.

Methods inherited from class org.orekit.parameter.Parameterizable

addParameter, getParameters, supportsParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

MassProperty

public MassProperty(double inMass)
             throws OrekitException

Constructor of this property.

Parameters:

inMass - The mass of the part.

Throws:

OrekitException - if inMass is negative (OrekitMessages.MASS_ARGUMENT_IS_NEGATIVE)

MassProperty

public MassProperty(Parameter inMass)
             throws OrekitException

Constructor of this property using a Parameter.

Parameters:

inMass - The mass of the part.

Throws:

OrekitException - if inMass is negative (OrekitMessages.MASS_ARGUMENT_IS_NEGATIVE)

Method Detail

getMass

public double getMass()

Gets the mass of the part.

Returns:

the mass

updateMass

public void updateMass(double newMass)
                throws OrekitException

Updates the mass of the part.

Parameters:

newMass - the mass

Throws:

OrekitException - if newMass is negative (OrekitMessages.MASS_ARGUMENT_IS_NEGATIVE)

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)