fr.cnes.sirius.patrius.bodies.bsp.spice

Class SpkSegment

java.lang.Object

fr.cnes.sirius.patrius.bodies.bsp.spice.SpkSegment

public class SpkSegment
extends Object

Class allowing to instantiate Spk Segments for the list in SpkBody.
The information stored here is the associated handle, description and identifier.

This class is based on the structure defined in SPKBSR.for in the SPICE library.

Since:

4.11

Author:

T0281925

Constructor Summary

Constructors

Constructor and Description
SpkSegment(int handle, double[] description, String id) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
double[]	getDescription() // Check for null input the descriptor of the segment.
int	getHandle() Getter for the handle associated to the segment.
String	getId() // Check for null input the identifier of the segment.
int	hashCode()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpkSegment

public SpkSegment(int handle,
                  double[] description,
                  String id)

Constructor.

Parameters:

handle - Handle associated to the segment

description - Descriptor associated to the segment

id - Identifier associated to the segment

Throws:

IllegalArgumentException - if id is null

Method Detail

getHandle

public int getHandle()

Getter for the handle associated to the segment.

Returns:

the handle associated to the segment

getDescription

public double[] getDescription()

// Check for null input the descriptor of the segment.

Returns:

the descriptor of the segment

getId

public String getId()

// Check for null input the identifier of the segment.

Returns:

the identifier of the segment

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object