DEIMOS
Earth Observation Mission CFI Software
Lib Software User Manual
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[4]) throw (CfiError)
 Class constructor: using time correlations.
 TimeCorrelation (long timeModel, vector< string > timeFiles, TimeInterval time, TimeInterval &valTime) throw (CfiError)
 Class constructor: using files and times.
 TimeCorrelation (long timeModel, vector< string > timeFiles, long timeRef, OrbitInterval orbits, TimeInterval &valTime) throw (CfiError)
 Class constructor: using files and orbits.
 TimeCorrelation (long timeModel, vector< string > timeFiles, long timeRef, TimeInterval &valTime) throw (CfiError)
 Class constructor: using files and default initialisation interval.
 TimeCorrelation ()
 Empty Class constructor: do not initialise time correlations.
 ~TimeCorrelation () throw (CfiError)
 Class destructor.
TimeCorrelationData getData ()
 Get data.
void getLeapSecondInfo (long asciiFormat, long &leapFlag, string &UtcTimeBeforeLeap, string &UtcTimeAfterLeap) throw (CfiError)
 Get leap second info.
void setData (TimeCorrelationData timeCorr)
 Set data.

Detailed Description

Class that stores the time correlations.


Constructor & Destructor Documentation

EECFI::TimeCorrelation::TimeCorrelation ( double  time_corr[4]  )  throw (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 
) throw (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 
) throw (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 
) throw (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.
EECFI::TimeCorrelation::TimeCorrelation (  ) 

Empty Class constructor: do not initialise time correlations.

EECFI::TimeCorrelation::~TimeCorrelation (  )  throw (CfiError)

Class destructor.


Member Function Documentation

void EECFI::TimeCorrelation::getLeapSecondInfo ( long  asciiFormat,
long &  leapFlag,
string &  utcTimeBeforeLeap,
string &  utcTimeAfterLeap 
) throw (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).
leapFlag [OUTPUT] Flag for leap second presence within time initialization data (-1 = Negative leap second; 0 = No leap second within initialization data; 1 = Positive leap second).
utcTimeBeforeLeap [OUTPUT] UTC time just before leap second insertion.
utcTimeAfterLeap [OUTPUT] UTC time just after leap second insertion.
void EECFI::TimeCorrelation::setData ( TimeCorrelationData  timeCorr  ) 

Generated on Thu Jul 15 2010 10:10:53 for by doxygen 1.7.1