Package org.orekit.forces

Class AbstractForceModel

java.lang.Object

org.orekit.forces.AbstractForceModel

All Implemented Interfaces:

ForceModel

Direct Known Subclasses:

AbstractParametricAcceleration, ConstantThrustManeuver, DragForce, HolmesFeatherstoneAttractionModel, NewtonianAttraction, OceanTides, Relativity, SolarRadiationPressure, SolidTides, ThirdBodyAttraction

public abstract class AbstractForceModel
extends Object
implements ForceModel

Base class for force models.

Since:

8.0

Author:

Luc Maisonobe

Constructor Summary

Constructors

Constructor	Description
AbstractForceModel()

Method Summary

Modifier and Type	Method	Description
protected void	complainIfNotSupported(String name)	Complain if a parameter is not supported.
ParameterDriver	getParameterDriver(String name)	Get parameter value from its name.
boolean	isSupported(String name)	Check if a parameter is supported.

Methods inherited from interface org.orekit.forces.ForceModel

acceleration, acceleration, addContribution, addContribution, dependsOnPositionOnly, getEventsDetectors, getFieldEventsDetectors, getParameters, getParameters, getParametersDrivers, init

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractForceModel

public AbstractForceModel()

Method Detail

getParameterDriver

public ParameterDriver getParameterDriver(String name)
                                   throws OrekitException

Get parameter value from its name.

Specified by:

getParameterDriver in interface ForceModel

Parameters:

name - parameter name

Returns:

parameter value

Throws:

OrekitException - if parameter is not supported

isSupported

public boolean isSupported(String name)

Check if a parameter is supported.

Supported parameters are those listed by ForceModel.getParametersDrivers().

Specified by:

isSupported in interface ForceModel

Parameters:

name - parameter name to check

Returns:

true if the parameter is supported

See Also:

ForceModel.getParametersDrivers()

complainIfNotSupported

protected void complainIfNotSupported(String name)
                               throws OrekitException

Complain if a parameter is not supported.

Parameters:

name - name of the parameter

Throws:

OrekitException - if the parameter is not supported