org.orekit.parameter
Class ConstantFunction

java.lang.Object
  org.orekit.parameter.Parameterizable
      org.orekit.parameter.ParamDiffFunction
          org.orekit.parameter.ConstantFunction

All Implemented Interfaces:

Serializable, IParamDiffFunction, IParameterizable, IParameterizableFunction

public class ConstantFunction
extends ParamDiffFunction

This class is used to define a constant parameterizable function.

Since:

2.3

Version:

$Id: ConstantFunction.java 17602 2017-05-18 08:25:23Z bignon $

Author:

auguief

See Also:

Serialized Form

Concurrency :

not thread-safe, uses internal mutable attributes

Constructor Summary

ConstantFunction(double value)
Simple constructor with a given name and value.

ConstantFunction(Parameter param)
Simple constructor with a given Parameter.

ConstantFunction(String name, double value)
Simple constructor with a given name and value.

Method Summary

double	derivativeValue(Parameter p, SpacecraftState state) Compute the derivative value with respect to the input parameter.
ArrayList<Parameter>	getParameters() Get the supported parameters.
double	value() Value of the parameter.
double	value(SpacecraftState s) Getting the value of the function.

Methods inherited from class org.orekit.parameter.ParamDiffFunction

isDifferentiableBy, supportsParameter

Methods inherited from class org.orekit.parameter.Parameterizable

addParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ConstantFunction

public ConstantFunction(Parameter param)

Simple constructor with a given Parameter.

Parameters:

param - a parameter

ConstantFunction

public ConstantFunction(String name,
                        double value)

Simple constructor with a given name and value.

Parameters:

name - a parameter name

value - a parameter value

ConstantFunction

public ConstantFunction(double value)

Simple constructor with a given name and value.

Parameters:

value - a parameter value

Method Detail

value

public double value(SpacecraftState s)

Getting the value of the function.

Parameters:

s - the spacecraft state

Returns:

the value of the function.

value

public double value()

Value of the parameter.

Returns:

the value of the parameter parameter as double

derivativeValue

public double derivativeValue(Parameter p,
                              SpacecraftState state)

Compute the derivative value with respect to the input parameter.

Parameters:

p - parameter

state - current state

Returns:

the derivative value

getParameters

public ArrayList<Parameter> getParameters()

Get the supported parameters.

Specified by:

getParameters in interface IParameterizable

Overrides:

getParameters in class Parameterizable

Returns:

list of supported parameters