fr.cnes.sirius.patrius.propagation.numerical

Class AdditionalStateInfo

java.lang.Object

fr.cnes.sirius.patrius.propagation.numerical.AdditionalStateInfo

All Implemented Interfaces:

Serializable, Cloneable

public final class AdditionalStateInfo
extends Object
implements Serializable, Cloneable

Utility class that describes in a minimal fashion the structure of an additional state. An instance contains the size of an additional state and its index in the state vector. The instance AdditionalStateInfo is guaranteed to be immutable.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdditionalStateInfo(int sizeIn, int indexIn) Constructor.

Method Summary

Modifier and Type	Method and Description
AdditionalStateInfo	clone() Copy of the AdditionalStateInfo.
int	getIndex() Get the index of the additional state in the state vector.
int	getSize() Get the size of the additional state.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdditionalStateInfo

public AdditionalStateInfo(int sizeIn,
                           int indexIn)

Constructor.

Parameters:

sizeIn - additional state size.

indexIn - additional state state index in the state vector.

Method Detail

getSize

public int getSize()

Get the size of the additional state.

Returns:

additional state size

getIndex

public int getIndex()

Get the index of the additional state in the state vector.

Returns:

additional state index in the state vector

clone

public AdditionalStateInfo clone()

Copy of the AdditionalStateInfo.

Overrides:

clone in class Object

Returns:

a copy of the AdditionalStateInfo object.