PsimuUtils (psimu 11.6.2 API)

java.lang.Object
- fr.cnes.dynvol.psimu.calc.utils.PsimuUtils

```
public final class PsimuUtils
extends Object
```
Class containing constants used in JPSIMU.

Author:

sumelzi

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`BINARY_RESULTS_FILE_NAME` Results binary file name.
`static String`	`BINARY_SC_COLUMN_DESC` Binary spacecraft state column desciption.
`static String`	`BINARY_SC_COLUMN_NAME` Binary spacecraft state column name.
`static String`	`CAL` Calendar unit string.
`static String`	`DATA_FILE` Data file ("data.xml").
`static String`	`DAY` Day string.
`static String`	`DEG` Degree string.
`static String`	`DEG_SEC` Deg/s string.
`static String`	`EPH_TABLE` Ephemeris table name in the sqlite database.
`static String`	`EVENT_COLUMN_NAME` Event column name in the sqlite database.
`static String`	`EVENT_TABLE` Events table name in the sqlite database.
`static double`	`GAP_DEG_180` Gap definition of 180 deg for angular units.
`static String`	`GRAMS` Gram string.
`static String`	`HOUR` Hour string.
`static String`	`KG_M3` Density units string.
`static String`	`KILOGRAMS` Kilo string.
`static String`	`KILOMETERS` Kilometer string.
`static int`	`MAX_SPAN` Default maximum span.
`static String`	`METERS` Meters string.
`static String`	`METERS_SEC` Velocity string.
`static String`	`METERS_SEC2` Acceleration string.
`static String`	`NEWTON` Thrust units string.
`static String`	`PERCENT` Percent unit string.
`static String`	`PREFIX_OUTPUT` Output prefix ("OUT_").
`static String`	`PREFIX_SCENARIO` Scenario prefix ("SCE_").
`static String`	`SEC` Seconds string.
`static String`	`SUFFIX_XML` XML suffix (".xml)".
`static String`	`UTC` UTC string.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static fr.cnes.sirius.patrius.propagation.SpacecraftState`	`fromBase64(String spacecraftStateString)` Read the object from Base64 string.
`static fr.cnes.genius.unit.GUnit[]`	`getTimeDaysUnitList()` Get the time unit list.
`static List<fr.cnes.sirius.patrius.propagation.SpacecraftState>`	`readSpacecraftStatesFromFile(boolean isEphem, boolean isEvent, String outputDirectory, String nameFile, String varName)` Method to initialize a list of spacecraft states from a SQlite file.
`static List<Map<String,Object>>`	`readVariablesFromFile(boolean isEphem, boolean isEvent, String outputDirectory, String nameFile, List<String> listOfVarnames)` Method to initialize a list of variables from a SQlite file.
`static String`	`toBase64(fr.cnes.sirius.patrius.propagation.SpacecraftState currentState)` Write the object to a Base64 string.

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

Field Detail
- MAX_SPAN
```
public static final int MAX_SPAN
```
  Default maximum span.
  
  See Also:
  
  Constant Field Values
- EPH_TABLE
```
public static final String EPH_TABLE
```
  Ephemeris table name in the sqlite database.
  
  See Also:
  
  Constant Field Values
- EVENT_TABLE
```
public static final String EVENT_TABLE
```
  Events table name in the sqlite database.
  
  See Also:
  
  Constant Field Values
- EVENT_COLUMN_NAME
```
public static final String EVENT_COLUMN_NAME
```
  Event column name in the sqlite database.
  
  See Also:
  
  Constant Field Values
- BINARY_SC_COLUMN_NAME
```
public static final String BINARY_SC_COLUMN_NAME
```
  Binary spacecraft state column name.
  
  See Also:
  
  Constant Field Values
- BINARY_SC_COLUMN_DESC
```
public static final String BINARY_SC_COLUMN_DESC
```
  Binary spacecraft state column desciption.
  
  See Also:
  
  Constant Field Values
- CAL
```
public static final String CAL
```
  Calendar unit string.
  
  See Also:
  
  Constant Field Values
- DEG
```
public static final String DEG
```
  Degree string.
  
  See Also:
  
  Constant Field Values
- KILOGRAMS
```
public static final String KILOGRAMS
```
  Kilo string.
  
  See Also:
  
  Constant Field Values
- GRAMS
```
public static final String GRAMS
```
  Gram string.
  
  See Also:
  
  Constant Field Values
- METERS
```
public static final String METERS
```
  Meters string.
  
  See Also:
  
  Constant Field Values
- KILOMETERS
```
public static final String KILOMETERS
```
  Kilometer string.
  
  See Also:
  
  Constant Field Values
- METERS_SEC
```
public static final String METERS_SEC
```
  Velocity string.
  
  See Also:
  
  Constant Field Values
- METERS_SEC2
```
public static final String METERS_SEC2
```
  Acceleration string.
  
  See Also:
  
  Constant Field Values
- DEG_SEC
```
public static final String DEG_SEC
```
  Deg/s string.
  
  See Also:
  
  Constant Field Values
- DAY
```
public static final String DAY
```
  Day string.
  
  See Also:
  
  Constant Field Values
- HOUR
```
public static final String HOUR
```
  Hour string.
  
  See Also:
  
  Constant Field Values
- SEC
```
public static final String SEC
```
  Seconds string.
  
  See Also:
  
  Constant Field Values
- UTC
```
public static final String UTC
```
  UTC string.
  
  See Also:
  
  Constant Field Values
- KG_M3
```
public static final String KG_M3
```
  Density units string.
  
  See Also:
  
  Constant Field Values
- NEWTON
```
public static final String NEWTON
```
  Thrust units string.
  
  See Also:
  
  Constant Field Values
- PERCENT
```
public static final String PERCENT
```
  Percent unit string.
  
  See Also:
  
  Constant Field Values
- PREFIX_SCENARIO
```
public static final String PREFIX_SCENARIO
```
  Scenario prefix ("SCE_").
  
  See Also:
  
  Constant Field Values
- PREFIX_OUTPUT
```
public static final String PREFIX_OUTPUT
```
  Output prefix ("OUT_").
  
  See Also:
  
  Constant Field Values
- SUFFIX_XML
```
public static final String SUFFIX_XML
```
  XML suffix (".xml)".
  
  See Also:
  
  Constant Field Values
- DATA_FILE
```
public static final String DATA_FILE
```
  Data file ("data.xml").
  
  See Also:
  
  Constant Field Values
- BINARY_RESULTS_FILE_NAME
```
public static final String BINARY_RESULTS_FILE_NAME
```
  Results binary file name.
  
  See Also:
  
  Constant Field Values
- GAP_DEG_180
```
public static final double GAP_DEG_180
```
  Gap definition of 180 deg for angular units.
  
  See Also:
  
  Constant Field Values

Method Detail

getTimeDaysUnitList
```
public static fr.cnes.genius.unit.GUnit[] getTimeDaysUnitList()
```
Get the time unit list.

Returns:

the time unit list.

readVariablesFromFile

public static List<Map<String,Object>> readVariablesFromFile(boolean isEphem,
                                                             boolean isEvent,
                                                             String outputDirectory,
                                                             String nameFile,
                                                             List<String> listOfVarnames)
                                                      throws fr.cnes.genius.exception.SqliteException

Method to initialize a list of variables from a SQlite file.

Parameters:: isEphem - flag to know if ephemeris table must be present; isEvent - flag to know if event table must be present; outputDirectory - name of the directory where is the db file to read; nameFile - name of the db file to read.; listOfVarnames - list of variables names to be read in the db file.
Returns:: list of variables
Throws:: fr.cnes.genius.exception.SqliteException - if a problem occurred with the SQLite reading

readSpacecraftStatesFromFile

public static List<fr.cnes.sirius.patrius.propagation.SpacecraftState> readSpacecraftStatesFromFile(boolean isEphem,
                                                                                                    boolean isEvent,
                                                                                                    String outputDirectory,
                                                                                                    String nameFile,
                                                                                                    String varName)
                                                                                             throws fr.cnes.genius.exception.SqliteException,
                                                                                                    PsimuOutputManagerException

Method to initialize a list of spacecraft states from a SQlite file.

Parameters:: isEphem - flag to know if ephemeris table must be present; isEvent - flag to know if event table must be present; outputDirectory - name of the directory where is the db file to read; nameFile - name of the db file to read; varName - name of the variable in the db file.
Returns:: list of spacecraft states.
Throws:: fr.cnes.genius.exception.SqliteException - if a problem occurred with the SQLite reading; PsimuOutputManagerException - if a problem occurred with the conversion S/C => binary

fromBase64
```
public static fr.cnes.sirius.patrius.propagation.SpacecraftState fromBase64(String spacecraftStateString)
                                                                     throws PsimuOutputManagerException
```
Read the object from Base64 string.

Parameters:

spacecraftStateString - spacecraft state coded as a base64 string.

Returns:

the spacecraft state.

Throws:

PsimuOutputManagerException - in case of problem converting the input string to a spacecraft state.

toBase64
```
public static String toBase64(fr.cnes.sirius.patrius.propagation.SpacecraftState currentState)
                       throws PsimuOutputManagerException
```
Write the object to a Base64 string.

Parameters:

currentState - spacecraft state.

Returns:

the base64 encoded string.

Throws:

PsimuOutputManagerException - in case the spacecraft state cannot be converted to string.

Class PsimuUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

MAX_SPAN

EPH_TABLE

EVENT_TABLE

EVENT_COLUMN_NAME

BINARY_SC_COLUMN_NAME

BINARY_SC_COLUMN_DESC

CAL

DEG

KILOGRAMS

GRAMS

METERS

KILOMETERS

METERS_SEC

METERS_SEC2

DEG_SEC

DAY

HOUR

SEC

UTC

KG_M3

NEWTON

PERCENT

PREFIX_SCENARIO

PREFIX_OUTPUT

SUFFIX_XML

DATA_FILE

BINARY_RESULTS_FILE_NAME

GAP_DEG_180

Method Detail

getTimeDaysUnitList

readVariablesFromFile

readSpacecraftStatesFromFile

fromBase64

toBase64