fr.cnes.dynvol.psimu.ihm.main

Class PsimuBatch

java.lang.Object

fr.cnes.dynvol.psimu.ihm.main.PsimuBatch

public class PsimuBatch
extends Object

Psimu batch mode. Given a scenario input data (SCE_[].xml), it allows to call JPSIMU subroutine mode, propagating the orbit and saving results in a binary file.

Author:

sumelzi

Constructor Summary

Constructors

Constructor and Description
PsimuBatch(String confFilename, String outputDir) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
List<fr.cnes.genopus.nonWidget.events.CustomEventDetector>	getListEventsToDetect() Get list of events to detect.
OutputConfig	getOutputConfig() Get output configuration.
Psimu	getPsimu() Get JPSIMU subroutine mode.
void	propagateInMasterMode() Propagates the orbit.
void	propagateInMasterMode(String resultName) Propagates the orbit.
fr.cnes.sirius.patrius.propagation.SpacecraftState	propagateInSlaveMode() Propagates in slave mode.
void	run(String outputDir, String resultName, String varListFilenameIn, boolean writeVts, boolean ephEveAutomaticSaving, boolean orbitAutomaticSaving) Main method (expected to be called from IHM).

Methods inherited from class java.lang.Object

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

Constructor Detail

PsimuBatch

public PsimuBatch(String confFilename,
                  String outputDir)
           throws PsimuException,
                  PsimuOutputManagerException

Creates a new instance.

Parameters:

confFilename - scenario input data (SCE_[].xml)

outputDir - output directory.

Throws:

PsimuException - if some internal error occurs

PsimuOutputManagerException - if the selected time scale isn't recognized

Method Detail

propagateInMasterMode

public void propagateInMasterMode()
                           throws PsimuPropagationException

Propagates the orbit. It is expected to be use when using IHM mode.

Throws:

PsimuPropagationException - if the propagation fails.

propagateInMasterMode

public void propagateInMasterMode(String resultName)
                           throws PsimuPropagationException

Propagates the orbit. It is expected to be use when using IHM mode.

Parameters:

resultName - prefix for the results.

Throws:

PsimuPropagationException - if the propagation fails.

propagateInSlaveMode

public fr.cnes.sirius.patrius.propagation.SpacecraftState propagateInSlaveMode()
                                                                        throws PsimuPropagationException

Propagates in slave mode.

Returns:

the final spacecraft state.

Throws:

PsimuPropagationException - if propagation fails.

getPsimu

public Psimu getPsimu()

Get JPSIMU subroutine mode.

Returns:

JPSIMU subroutine mode

getOutputConfig

public OutputConfig getOutputConfig()

Get output configuration.

Returns:

the output configuration

getListEventsToDetect

public List<fr.cnes.genopus.nonWidget.events.CustomEventDetector> getListEventsToDetect()

Get list of events to detect.

Returns:

the listEventsToDetect

run

public void run(String outputDir,
                String resultName,
                String varListFilenameIn,
                boolean writeVts,
                boolean ephEveAutomaticSaving,
                boolean orbitAutomaticSaving)
         throws PsimuException

Main method (expected to be called from IHM).

Parameters:

outputDir - output directory for the results.

resultName - prefix for the results.

varListFilenameIn - name of the file containing the variables to send to the EPH and EVENT files.

writeVts - if the VTS output files shall be generated.

ephEveAutomaticSaving - automatic saving of the ephemerides and events files.

orbitAutomaticSaving - automatic saving of orbit file.

Throws:

PsimuException - if some internal error occurs