Package org.orekit.utils

Class DataDictionary.Entry

java.lang.Object

org.orekit.utils.DataDictionary.Entry

All Implemented Interfaces:

Serializable

Enclosing class:

DataDictionary

public static class DataDictionary.Entry
extends Object
implements Serializable

Entry in a dictionary.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
String	getKey()	Get the entry key.
Object	getValue()	Get the value.
void	increment(double[] increment)	Increment the value if it is a double array.
void	scaledIncrement(double factor, DoubleArrayDictionary.Entry raw)	Increment the value with another scaled entry if it is a double array.
void	zero()	Reset the value to zero if it is a double array.

Methods inherited from class java.lang.Object

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

Method Detail

getKey

public String getKey()

Get the entry key.

Returns:

entry key

getValue

public Object getValue()

Get the value.

Returns:

a copy of the value (independent from internal array if it is a double array)

increment

public void increment(double[] increment)

Increment the value if it is a double array.

For the sake of performance, no checks are done on argument.

Parameters:

increment - increment to apply to the entry value

scaledIncrement

public void scaledIncrement(double factor,
                            DoubleArrayDictionary.Entry raw)

Increment the value with another scaled entry if it is a double array.

Each component value[i] will be replaced by value[i] + factor * raw.value[i].

For the sake of performance, no checks are done on arguments.

Parameters:

factor - multiplicative factor for increment

raw - raw increment to be multiplied by factor and then added

zero

public void zero()

Reset the value to zero if it is a double array.