DEIMOS
Earth Observation Mission CFI Software
Lib Software User Manual
for JAVA
ESA

EECFI.TimeCorrelation Class Reference

Class that stores the time correlations. More...

Inheritance diagram for EECFI.TimeCorrelation:
EECFI.CfiId EECFI.CfiClass

List of all members.

Public Member Functions

 TimeCorrelation (double time_corr[]) throws CfiError
 Class constructor: using time correlations.
 TimeCorrelation (long timeModel, Vector< String > timeFiles, TimeInterval time, TimeInterval valTime) throws CfiError
 Class constructor: using files and times.
 TimeCorrelation (long timeModel, Vector< String > timeFiles, long timeRef, OrbitInterval orbits, TimeInterval valTime) throws CfiError
 Class constructor: using files and orbits.
 TimeCorrelation (long timeModel, Vector< String > timeFiles, long timeRef, TimeInterval valTime) throws CfiError
 Class constructor: using files and default initialisation interval.
native TimeCorrelationData getData ()
 Get data.
native LeapSecond getLeapSecondInfo (long asciiFormat) throws CfiError
 Get leap second info.
native void setData (TimeCorrelationData timeCorr)
 Set data.

Detailed Description

Class that stores the time correlations.


Constructor & Destructor Documentation

EECFI.TimeCorrelation::TimeCorrelation ( double  time_corr[]  )  throws CfiError

Class constructor: using time correlations.

Parameters:
time_corr Time correlations array: [0] = TAI time (Decimal days - Processing format). Allowed range=[-18262.0, 36524.0]
[1] = UTC time (Decimal days - Processing format). Allowed range=[-18262.0, 36524.0]
[2] = UT1 time (Decimal days - Processing format). Allowed range=[-18262.0, 36524.0]
[3] = GPS time (Decimal days - Processing format). Allowed range=[-18262.0, 36524.0].
EECFI.TimeCorrelation::TimeCorrelation ( long  timeModel,
Vector< String >  timeFiles,
TimeInterval  time,
TimeInterval  valTime 
) throws CfiError

Class constructor: using files and times.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: complete except XLCFI_TIMEMOD_USER.
Note: when the input file is an IERS Bulleting B file and the time mode is XLCFI_TIMEMOD_AUTO, then the time model is set automatically to XLCFI_TIMEMOD_IERS_B_RESTITUTED.
Time interval initialisation is not allowed for Orbit Scenario Files.
timeFiles Array of files.
time Requested initialisation time window.
valTime [OUTPUT] Time validity interval.
EECFI.TimeCorrelation::TimeCorrelation ( long  timeModel,
Vector< String >  timeFiles,
long  timeRef,
OrbitInterval  orbits,
TimeInterval  valTime 
) throws CfiError

Class constructor: using files and orbits.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: complete except XLCFI_TIMEMOD_USER.
Initialisation with orbit interval is not allowed for IERS Bulletins, DORIS Navigator files nor Orbit Scenario Files files.
timeFiles Array of files.
timeRef Time reference for the validity interval.
orbits Requested initialisation orbit window.
valTime [OUTPUT] Time validity interval.
EECFI.TimeCorrelation::TimeCorrelation ( long  timeModel,
Vector< String >  timeFiles,
long  timeRef,
TimeInterval  valTime 
) throws CfiError

Class constructor: using files and default initialisation interval.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: complete except XLCFI_TIMEMOD_USER.
Note: when the input file is an IERS Bulleting B file and the time mode is XLCFI_TIMEMOD_AUTO, then the time model is set automatically to XLCFI_TIMEMOD_IERS_B_RESTITUTED.
timeFiles Array of files.
timeRef Time reference for the validity interval.
valTime [OUTPUT] Time validity interval.

Member Function Documentation

TimeCorrelationData EECFI.TimeCorrelation::getData (  ) 

Get data.

Returns:
Time correlation data.
LeapSecond EECFI.TimeCorrelation::getLeapSecondInfo ( long  asciiFormat  )  throws CfiError

Get leap second info.

Note that, if the time correlations where initalised with an Orbit Scenario File, leap seconds could be wrongly calculated.

Parameters:
asciiFormat Ascii format (TimeAsciiEnum).
void EECFI.TimeCorrelation::setData ( TimeCorrelationData  timeCorr  ) 

Set data.

Parameters:
timeCorr Time correlation data.

Generated on Thu Apr 7 2011 16:12:30 for by doxygen 1.7.1