SpkBody (patrimoine de base SIRIUS 4.13 API)

java.lang.Object
- fr.cnes.sirius.patrius.bodies.bsp.spice.SpkBody

```
public class SpkBody
extends Object
```
Class that allows to instantiate a SpkBody to be used in SpkFile.
Each body contains all the segments corresponding to it that were read among other informations.
This class is based on the data structure description of SPKBSR in the SPICE library.

Since:

4.11

Author:

T0281925

Field Summary

Fields
Modifier and Type Field and Description

static int SIZEDESC
Size of the descriptor array.

Fields
Modifier and Type	Field and Description
`static int`	`SIZEDESC` Size of the descriptor array.

Constructor Summary

Constructors
Constructor and Description
`SpkBody(int body)` Simple constructor for finding SpkBody in a list.
`SpkBody(int body, int expense, int highestFile, int lowestFile, double lowerBound, double upperBound, double[] previousDescriptor, String previousSegmentId, int previousHandle, boolean checkPrevious, int reuseExpense)` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`int`	`getExpense()` Getter for the expense.
`int`	`getHighestFile()` Getter for the highest file number searched during the construction of the segment list.
`double`	`getLowerBound()` Getter for the lower bound of the re-use interval.
`int`	`getLowestFile()` Getter for the lowest file number searched during the construction of the segment list.
`double[]`	`getPreviousDescriptor()` Getter for the previous descriptor returned.
`int`	`getPreviousHandle()` Getter for the previous handle returned.
`String`	`getPreviousSegmentId()` Getter for the previous segment identifier returned.
`int`	`getReuseExpense()` Getter for the expense of the re-use interval.
`List<SpkSegment>`	`getSegmentTable()` Getter for the segment list.
`double`	`getUpperBound()` Getter for the upper bound of the re-use interval.
`int`	`hashCode()`
`boolean`	`isCheckPrevious()` Indicates if the previous segment needs to be check.
`void`	`setCheckPrevious(boolean checkPrevious)` Setter for the boolean indicating if the previous segment needs to be checked.
`void`	`setExpense(int expense)` Setter for the expense associated to a body.
`void`	`setHighestFile(int highestFile)` Setter for the highest file number searched during the construction of the segment list.
`void`	`setLowerBound(double lowerBound)` Setter for the lower bound of the re-use interval.
`void`	`setLowestFile(int lowestFile)` Setter for the lowest file number searched during the construction of the segment list.
`void`	`setPreviousDescriptor(double[] previousDescriptor)` Setter for the previous descriptor returned.
`void`	`setPreviousHandle(int previousHandle)` Setter for the previous handle returned.
`void`	`setPreviousSegmentId(String previousSegmentId)` Setter for the previous segment identifier returned.
`void`	`setReuseExpense(int reuseExpense)` Setter for the expense of the re-use interval.
`void`	`setUpperBound(double upperBound)` Setter for the upper bound of the re-use interval.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SIZEDESC
```
public static final int SIZEDESC
```
    Size of the descriptor array.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - SpkBody
```
public SpkBody(int body,
               int expense,
               int highestFile,
               int lowestFile,
               double lowerBound,
               double upperBound,
               double[] previousDescriptor,
               String previousSegmentId,
               int previousHandle,
               boolean checkPrevious,
               int reuseExpense)
```
    Constructor.
    
    Parameters:
    
    body - body id
    
    expense - Expense at which the segments list was constructed.
    
    highestFile - highest file number searched during the construction of the segment list
    
    lowestFile - lowest file number searched during the construction of the segment list
    
    lowerBound - Lower bound of the re-use interval of the previous segment returned
    
    upperBound - Upper bound of the re-use interval of the previous segment returned
    
    previousDescriptor - Previous descriptor returned
    
    previousSegmentId - Previous segment identifier returned
    
    previousHandle - Previous handle returned
    
    checkPrevious - Logical indicating that previous segment should be checked
    
    reuseExpense - Expense of the re-use interval
  - SpkBody
```
public SpkBody(int body)
```
    Simple constructor for finding SpkBody in a list.
    
    Parameters:
    
    body - Body identifier
- Method Detail
  - getSegmentTable
```
public List<SpkSegment> getSegmentTable()
```
    Getter for the segment list.
    
    Returns:
    
    a list containing all the segments concerning the body
  - getExpense
```
public int getExpense()
```
    Getter for the expense.
    
    Returns:
    
    the expense associated to the body
  - setExpense
```
public void setExpense(int expense)
```
    Setter for the expense associated to a body.
    
    Parameters:
    
    expense - Expense to associate to the body
  - getHighestFile
```
public int getHighestFile()
```
    Getter for the highest file number searched during the construction of the segment list.
    
    Returns:
    
    the highest file number searched during the construction of the segment list
  - setHighestFile
```
public void setHighestFile(int highestFile)
```
    Setter for the highest file number searched during the construction of the segment list.
    
    Parameters:
    
    highestFile - highest file number searched during the construction of the segment list
  - getLowestFile
```
public int getLowestFile()
```
    Getter for the lowest file number searched during the construction of the segment list.
    
    Returns:
    
    the lowest file number searched during the construction of the segment list
  - setLowestFile
```
public void setLowestFile(int lowestFile)
```
    Setter for the lowest file number searched during the construction of the segment list.
    
    Parameters:
    
    lowestFile - the lowest file number searched during the construction of the segment list
  - getLowerBound
```
public double getLowerBound()
```
    Getter for the lower bound of the re-use interval.
    
    Returns:
    
    the lower bound of the re-use interval
  - setLowerBound
```
public void setLowerBound(double lowerBound)
```
    Setter for the lower bound of the re-use interval.
    
    Parameters:
    
    lowerBound - the lower bound of the re-use interval
  - getUpperBound
```
public double getUpperBound()
```
    Getter for the upper bound of the re-use interval.
    
    Returns:
    
    the upper bound of the re-use interval
  - setUpperBound
```
public void setUpperBound(double upperBound)
```
    Setter for the upper bound of the re-use interval.
    
    Parameters:
    
    upperBound - the upper bound of the re-use interval
  - getPreviousDescriptor
```
public double[] getPreviousDescriptor()
```
    Getter for the previous descriptor returned.
    
    Returns:
    
    Previous descriptor returned.
  - setPreviousDescriptor
```
public void setPreviousDescriptor(double[] previousDescriptor)
```
    Setter for the previous descriptor returned.
    
    Parameters:
    
    previousDescriptor - Previous descriptor returned.
  - getPreviousSegmentId
```
public String getPreviousSegmentId()
```
    Getter for the previous segment identifier returned.
    
    Returns:
    
    the previous segment identifier returned
  - setPreviousSegmentId
```
public void setPreviousSegmentId(String previousSegmentId)
```
    Setter for the previous segment identifier returned.
    
    Parameters:
    
    previousSegmentId - the previous segment identifier returned
  - getPreviousHandle
```
public int getPreviousHandle()
```
    Getter for the previous handle returned.
    
    Returns:
    
    the previous handle returned
  - setPreviousHandle
```
public void setPreviousHandle(int previousHandle)
```
    Setter for the previous handle returned.
    
    Parameters:
    
    previousHandle - the previous handle returned
  - isCheckPrevious
```
public boolean isCheckPrevious()
```
    Indicates if the previous segment needs to be check.
    
    Returns:
    
    a boolean indicating if the previous segment needs to be checked
  - setCheckPrevious
```
public void setCheckPrevious(boolean checkPrevious)
```
    Setter for the boolean indicating if the previous segment needs to be checked.
    
    Parameters:
    
    checkPrevious - boolean indicating if the previous segment needs to be checked
  - getReuseExpense
```
public int getReuseExpense()
```
    Getter for the expense of the re-use interval.
    
    Returns:
    
    the expense of the re-use interval
  - setReuseExpense
```
public void setReuseExpense(int reuseExpense)
```
    Setter for the expense of the re-use interval.
    
    Parameters:
    
    reuseExpense - the expense of the re-use interval
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class SpkBody

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SIZEDESC

Constructor Detail

SpkBody

SpkBody

Method Detail

getSegmentTable

getExpense

setExpense

getHighestFile

setHighestFile

getLowestFile

setLowestFile

getLowerBound

setLowerBound

getUpperBound

setUpperBound

getPreviousDescriptor

setPreviousDescriptor

getPreviousSegmentId

setPreviousSegmentId

getPreviousHandle

setPreviousHandle

isCheckPrevious

setCheckPrevious

getReuseExpense

setReuseExpense

hashCode

equals