fr.cnes.dynvol.psimu.calc.output

Class OutputConfig

java.lang.Object

fr.cnes.dynvol.psimu.calc.output.OutputConfig

public class OutputConfig
extends Object

Class containing the output configuration.

Author:

sumelzi

Constructor Summary

Constructors

Constructor and Description
OutputConfig(fr.cnes.sirius.patrius.frames.Frame outputFrame, fr.cnes.sirius.patrius.frames.LOFType loftType, double outputFrequency) Creates a new instance with default time scale (TAI).
OutputConfig(fr.cnes.sirius.patrius.frames.Frame outputFrame, fr.cnes.sirius.patrius.frames.LOFType loftType, double outputFrequency, fr.cnes.sirius.patrius.time.TimeScale outputTimeScale) Creates a new instance.
OutputConfig(fr.cnes.sirius.patrius.frames.Frame outputFrame, fr.cnes.sirius.patrius.frames.LOFType loftType, double outputFrequency, fr.cnes.sirius.patrius.time.TimeScale outputTimeScale, boolean ephemeridesFileAutoSaveIn, boolean eventsFileAutoSaveIn, boolean vtsFilesAutoSaveIn, boolean finalOrbitFileAutoSaveIn, boolean scenarioFileAutoSaveIn, String outputVariablesListFileNameIn) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
void	addOutputVarsFunction(INewVarsFunction newVarsFunction) Method to add new output variables function.
List<INewVarsFunction>	getListOfNewVarsFunctions() Method to get the list of new variables functions.
fr.cnes.sirius.patrius.frames.LOFType	getLOType() Get the LOF type.
String	getOutputDirectory() Get the output directory to store the results.
fr.cnes.sirius.patrius.frames.Frame	getOutputFrame() Get the output frame.
double	getOutputFrequency() Get the output frequency.
fr.cnes.sirius.patrius.time.TimeScale	getOutputTimeScale() Get the output time scale.
String	getOutputVariablesListFileName() Getter for the name of the file with the list of the output variables to be saved.
boolean	isEphemeridesFileAutoSaveValue() Getter for the value of the ephemerides file automatic saving boolean.
boolean	isEventsFileAutoSaveValue() Getter for the value of the events file automatic saving boolean.
boolean	isFinalOrbitFileAutoSaveValue() Getter for the value of the final orbit file automatic saving boolean.
boolean	isScenarioFileAutoSaveValue() Getter for the value of the scenario file automatic saving boolean.
boolean	isVtsFilesAutoSaveValue() Getter for the value of the VTS files automatic saving boolean.
void	setOutputDirectory(String outputDirectory) Set the output directory to store the results.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputConfig

public OutputConfig(fr.cnes.sirius.patrius.frames.Frame outputFrame,
                    fr.cnes.sirius.patrius.frames.LOFType loftType,
                    double outputFrequency)

Creates a new instance with default time scale (TAI).

Parameters:

outputFrame - output frame

loftType - local orbital output frame type

outputFrequency - output frequency (s)

OutputConfig

public OutputConfig(fr.cnes.sirius.patrius.frames.Frame outputFrame,
                    fr.cnes.sirius.patrius.frames.LOFType loftType,
                    double outputFrequency,
                    fr.cnes.sirius.patrius.time.TimeScale outputTimeScale)

Creates a new instance.

Parameters:

outputFrame - output frame

loftType - local orbital output frame type

outputFrequency - output frequency (s)

outputTimeScale - output time scale

OutputConfig

public OutputConfig(fr.cnes.sirius.patrius.frames.Frame outputFrame,
                    fr.cnes.sirius.patrius.frames.LOFType loftType,
                    double outputFrequency,
                    fr.cnes.sirius.patrius.time.TimeScale outputTimeScale,
                    boolean ephemeridesFileAutoSaveIn,
                    boolean eventsFileAutoSaveIn,
                    boolean vtsFilesAutoSaveIn,
                    boolean finalOrbitFileAutoSaveIn,
                    boolean scenarioFileAutoSaveIn,
                    String outputVariablesListFileNameIn)

Creates a new instance.

Parameters:

outputFrame - output frame

loftType - local orbital output frame type

outputFrequency - output frequency (s)

outputTimeScale - output time scale

ephemeridesFileAutoSaveIn - automatic saving of the ephemerides file

eventsFileAutoSaveIn - automatic saving of the events file

vtsFilesAutoSaveIn - automatic saving of the VTS files

finalOrbitFileAutoSaveIn - automatic saving of the final orbit file

scenarioFileAutoSaveIn - automatic saving of the scenario file

outputVariablesListFileNameIn - name of the file with the list of the output variables to be saved

Method Detail

setOutputDirectory

public void setOutputDirectory(String outputDirectory)

Set the output directory to store the results.

Parameters:

outputDirectory - the output directory to store the results.

getOutputDirectory

public String getOutputDirectory()

Get the output directory to store the results.

Returns:

outputDirectory the output directory to store the results.

getLOType

public fr.cnes.sirius.patrius.frames.LOFType getLOType()

Get the LOF type.

Returns:

the LOF type.

getOutputFrame

public fr.cnes.sirius.patrius.frames.Frame getOutputFrame()

Get the output frame.

Returns:

the output frame

getOutputFrequency

public double getOutputFrequency()

Get the output frequency.

Returns:

the output frequency

getOutputTimeScale

public fr.cnes.sirius.patrius.time.TimeScale getOutputTimeScale()

Get the output time scale.

Returns:

the output time scale

addOutputVarsFunction

public void addOutputVarsFunction(INewVarsFunction newVarsFunction)

Method to add new output variables function.

Parameters:

newVarsFunction - output variable functions

getListOfNewVarsFunctions

public List<INewVarsFunction> getListOfNewVarsFunctions()

Method to get the list of new variables functions.

Returns:

new list of new variables functions.

isEphemeridesFileAutoSaveValue

public boolean isEphemeridesFileAutoSaveValue()

Getter for the value of the ephemerides file automatic saving boolean.

Returns:

the value of the boolean of the automatic saving of the ephemerides file.

isEventsFileAutoSaveValue

public boolean isEventsFileAutoSaveValue()

Getter for the value of the events file automatic saving boolean.

Returns:

the value of the boolean of the automatic saving of the events file.

isVtsFilesAutoSaveValue

public boolean isVtsFilesAutoSaveValue()

Getter for the value of the VTS files automatic saving boolean.

Returns:

the value of the boolean of the automatic saving of the VTS files.

isFinalOrbitFileAutoSaveValue

public boolean isFinalOrbitFileAutoSaveValue()

Getter for the value of the final orbit file automatic saving boolean.

Returns:

the value of the boolean of the automatic saving of the final orbit file.

isScenarioFileAutoSaveValue

public boolean isScenarioFileAutoSaveValue()

Getter for the value of the scenario file automatic saving boolean.

Returns:

the value of the boolean of the automatic saving of the scenario file.

getOutputVariablesListFileName

public String getOutputVariablesListFileName()

Getter for the name of the file with the list of the output variables to be saved.

Returns:

the name of the file with the list of the output variables to be saved.