DEIMOS
Earth Observation Mission CFI Software
Lib Software User Manual		 ESA
Public Member Functions

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])
 Class constructor: using time correlations.
 TimeCorrelation (long timeModel, const std::vector< std::string > &timeFiles, const TimeInterval &time, TimeInterval &valTime)
 Class constructor: using files and times.
 TimeCorrelation (long timeModel, const std::vector< std::string > &timeFiles, long timeRef, const OrbitInterval &orbits, TimeInterval &valTime)
 Class constructor: using files and orbits.
 TimeCorrelation (long timeModel, const std::vector< std::string > &timeFiles, long timeRef, TimeInterval &valTime)
 Class constructor: using files and default initialisation interval.
 TimeCorrelation (long timeModel, const std::vector< OsfFile > &fileData, const TimeInterval &time, TimeInterval &valTime)
 Class constructor: using data read from OSF files and times.
 TimeCorrelation (long timeModel, const std::vector< OsfFile > &fileData, long timeRef, const OrbitInterval &orbits, TimeInterval &valTime)
 Class constructor: using data read from OSF files and orbits.
 TimeCorrelation (long timeModel, const std::vector< OsfFile > &fileData, long timeRef, TimeInterval &valTime)
 Class constructor: using data read from OSF files and default initialisation interval.
 TimeCorrelation (long timeModel, const std::vector< OrbitFile > &fileData, const TimeInterval &time, TimeInterval &valTime)
 Class constructor: using data read from Orbit files and times.
 TimeCorrelation (long timeModel, const std::vector< OrbitFile > &fileData, long timeRef, const OrbitInterval &orbits, TimeInterval &valTime)
 Class constructor: using data read from Orbit files and orbits.
 TimeCorrelation (long timeModel, const std::vector< OrbitFile > &fileData, long timeRef, TimeInterval &valTime)
 Class constructor: using data read from Orbit files and default initialisation interval.
 TimeCorrelation (long timeModel, const std::vector< DorisFile > &fileData, const TimeInterval &time, TimeInterval &valTime)
 Class constructor: using data read from DORIS Navigator files and times.
 TimeCorrelation (long timeModel, const std::vector< DorisFile > &fileData, long timeRef, const OrbitInterval &orbits, TimeInterval &valTime)
 Class constructor: using data read from DORIS Navigator files and orbits.
 TimeCorrelation (long timeModel, const std::vector< DorisFile > &fileData, long timeRef, TimeInterval &valTime)
 Class constructor: using data read from DORIS Navigator files and default initialisation interval.
 TimeCorrelation (long timeModel, const std::vector< IersBulletinFile > &fileData, const TimeInterval &time, TimeInterval &valTime)
 Class constructor: using data read from IERS bulletin files and times.
 TimeCorrelation (long timeModel, const std::vector< IersBulletinFile > &fileData, long timeRef, const OrbitInterval &orbits, TimeInterval &valTime)
 Class constructor: using data read from IERS bulletin files and orbits.
 TimeCorrelation (long timeModel, const std::vector< IersBulletinFile > &fileData, long timeRef, TimeInterval &valTime)
 Class constructor: using data read from IERS bulletin files and default initialisation interval.
 TimeCorrelation (const TimeCorrelationData &timeData, long timeRef, TimeInterval &valTime)
 Class constructor: with user define Time correlation data.
 TimeCorrelation ()
 Default constructor: do not initialise time correlations.
 TimeCorrelation (const TimeCorrelation &other)
virtual ~TimeCorrelation () EXCEPT
 Class destructor.
TimeCorrelationData getData () const
 Get data.
void getLeapSecondInfo (long asciiFormat, long &leapFlag, std::string &UtcTimeBeforeLeap, std::string &UtcTimeAfterLeap) const
 Get leap second info.
void setData (const TimeCorrelationData &timeCorr)
 Set data (the TimeCorrelation object has to be initialized).
TimeCorrelation & operator= (const TimeCorrelation &other)

Detailed Description

Class that stores the time correlations.

Constructor & Destructor Documentation

EECFI::TimeCorrelation::TimeCorrelation ( double  time_corr[4]  )  [explicit]

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].

References EECFI::CfiId::addInstance(), and EECFI::CfiClass::throwWarn.

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< std::string > &  timeFiles,
const TimeInterval &  time,
TimeInterval &  valTime 
)

Class constructor: using files and times.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

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.

References EECFI::TimeInterval::timeRef.

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< std::string > &  timeFiles,
long  timeRef,
const OrbitInterval &  orbits,
TimeInterval &  valTime 
)

Class constructor: using files and orbits.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

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,
const std::vector< std::string > &  timeFiles,
long  timeRef,
TimeInterval &  valTime 
)

Class constructor: using files and default initialisation interval.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

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 ( long  timeModel,
const std::vector< OsfFile > &  fileData,
const TimeInterval &  timeInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from OSF files and times.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range:

  • XLCFI_TIMEMOD_OSF
  • XLCFI_TIMEMOD_AUTO
fileData Array of files.
timeInterval Requested initialisation time window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), EECFI::CfiId::status(), and EECFI::TimeInterval::timeRef.

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< OsfFile > &  fileData,
long  timeRef,
const OrbitInterval &  orbitInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from OSF files and orbits.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range:

  • XLCFI_TIMEMOD_OSF
  • XLCFI_TIMEMOD_AUTO
fileData Array of files.
timeRef Time reference for the validity interval.
orbits Requested initialisation orbit window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< OsfFile > &  fileData,
long  timeRef,
TimeInterval &  valTime 
)

Class constructor: using data read from OSF files and default initialisation interval.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range:

  • XLCFI_TIMEMOD_OSF
  • XLCFI_TIMEMOD_AUTO
fileData Array of files.
timeRef Time reference for the validity interval.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< OrbitFile > &  fileData,
const TimeInterval &  timeInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from Orbit files and times.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: XLCFI_TIMEMOD_FOS_PREDICTED.
XLCFI_TIMEMOD_FOS_RESTITUTED.
XLCFI_TIMEMOD_DORIS_PRELIMINARY.
XLCFI_TIMEMOD_DORIS_PRECISE.
XLCFI_TIMEMOD_AUTO.
fileData Array of files.
timeInterval Requested initialisation time window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), EECFI::CfiId::status(), and EECFI::TimeInterval::timeRef.

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< OrbitFile > &  fileData,
long  timeRef,
const OrbitInterval &  orbitInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from Orbit files and orbits.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: XLCFI_TIMEMOD_FOS_PREDICTED.
XLCFI_TIMEMOD_FOS_RESTITUTED.
XLCFI_TIMEMOD_DORIS_PRELIMINARY.
XLCFI_TIMEMOD_DORIS_PRECISE.
XLCFI_TIMEMOD_AUTO.
fileData Array of files.
timeRef Time reference for the validity interval.
orbits Requested initialisation orbit window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< OrbitFile > &  fileData,
long  timeRef,
TimeInterval &  valTime 
)

Class constructor: using data read from Orbit files and default initialisation interval.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: XLCFI_TIMEMOD_FOS_PREDICTED.
XLCFI_TIMEMOD_FOS_RESTITUTED.
XLCFI_TIMEMOD_DORIS_PRELIMINARY.
XLCFI_TIMEMOD_DORIS_PRECISE.
XLCFI_TIMEMOD_AUTO.
fileData Array of files.
timeRef Time reference for the validity interval.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< DorisFile > &  fileData,
const TimeInterval &  timeInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from DORIS Navigator files and times.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range:

  • XLCFI_TIMEMOD_DORIS_NAVIGATOR
  • XLCFI_TIMEMOD_AUTO
fileData Array of files.
timeInterval Requested initialisation time window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), EECFI::CfiId::status(), and EECFI::TimeInterval::timeRef.

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< DorisFile > &  fileData,
long  timeRef,
const OrbitInterval &  orbitInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from DORIS Navigator files and orbits.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range:

  • XLCFI_TIMEMOD_DORIS_NAVIGATOR
  • XLCFI_TIMEMOD_AUTO
fileData Array of files.
timeRef Time reference for the validity interval.
orbits Requested initialisation orbit window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< DorisFile > &  fileData,
long  timeRef,
TimeInterval &  valTime 
)

Class constructor: using data read from DORIS Navigator files and default initialisation interval.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range:

  • XLCFI_TIMEMOD_DORIS_NAVIGATOR
  • XLCFI_TIMEMOD_AUTO
fileData Array of files.
timeRef Time reference for the validity interval.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< IersBulletinFile > &  fileData,
const TimeInterval &  timeInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from IERS bulletin files and times.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: XLCFI_TIMEMOD_IERS_B_PREDICTED
XLCFI_TIMEMOD_IERS_B_RESTITUTED
XLCFI_TIMEMOD_IERS_A_ONLY_PREDICTION
XLCFI_TIMEMOD_IERS_A_PREDICTION_AND_FORMULA
XLCFI_TIMEMOD_IERS_B_AND_A_ONLY_PREDICTION
XLCFI_TIMEMOD_AUTO
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.
fileData Array of files.
timeInterval Requested initialisation time window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), EECFI::CfiId::status(), and EECFI::TimeInterval::timeRef.

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< IersBulletinFile > &  fileData,
long  timeRef,
const OrbitInterval &  orbitInterval,
TimeInterval &  valTime 
)

Class constructor: using data read from IERS bulletin files and orbits.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: XLCFI_TIMEMOD_IERS_B_PREDICTED
XLCFI_TIMEMOD_IERS_B_RESTITUTED
XLCFI_TIMEMOD_IERS_A_ONLY_PREDICTION
XLCFI_TIMEMOD_IERS_A_PREDICTION_AND_FORMULA
XLCFI_TIMEMOD_IERS_B_AND_A_ONLY_PREDICTION
XLCFI_TIMEMOD_AUTO
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.
fileData Array of files.
timeRef Time reference for the validity interval.
orbits Requested initialisation orbit window.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( long  timeModel,
const std::vector< IersBulletinFile > &  fileData,
long  timeRef,
TimeInterval &  valTime 
)

Class constructor: using data read from IERS bulletin files and default initialisation interval.

In order to read files, this method internally uses Data Handling functions. Please refer to [D_H_SUM] for further details.

Parameters:
timeModel Time model (TimeModelEnum).
Allowed range: XLCFI_TIMEMOD_IERS_B_PREDICTED
XLCFI_TIMEMOD_IERS_B_RESTITUTED
XLCFI_TIMEMOD_IERS_A_ONLY_PREDICTION
XLCFI_TIMEMOD_IERS_A_PREDICTION_AND_FORMULA
XLCFI_TIMEMOD_IERS_B_AND_A_ONLY_PREDICTION
XLCFI_TIMEMOD_AUTO
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.
fileData Array of files.
timeRef Time reference for the validity interval.
valTime [OUTPUT] Time validity interval.

References EECFI::CfiError::addMsg(), and EECFI::CfiId::status().

EECFI::TimeCorrelation::TimeCorrelation ( const TimeCorrelationData &  timeData,
long  timeRef,
TimeInterval &  valTime 
)

Class constructor: with user define Time correlation data.

References EECFI::CfiId::addInstance(), EECFI::TimeCorrelationData::iersBulletinType, EECFI::TimeCorrelationData::iersFormulaFlag, setData(), EECFI::TimeInterval::startTime, EECFI::TimeInterval::stopTime, EECFI::CfiClass::throwWarn, EECFI::TimeCorrelationData::timeCorrVector, and EECFI::TimeInterval::timeRef.

EECFI::TimeCorrelation::TimeCorrelation (  ) 

Default constructor: do not initialise time correlations.

EECFI::TimeCorrelation::TimeCorrelation ( const TimeCorrelation &  other  ) 

Copy constructor

Parameters:
other The TimeCorrelation to copy from
EECFI::TimeCorrelation::~TimeCorrelation (  )  [virtual]

Class destructor.

Member Function Documentation

TimeCorrelationData EECFI::TimeCorrelation::getData (  )  const

Get data.

Returns:
Time correlation data.

References EECFI::LaunchInertialFrameConfig::enabledFlag, EECFI::LeapSecondInfo::flag, EECFI::TimeCorrelationData::iersBulletinType, EECFI::TimeCorrelationData::iersFormulaFlag, EECFI::TimeCorrelationData::launchInertialFrameConfig, EECFI::TimeCorrelationData::leapSecond, EECFI::LaunchInertialFrameConfig::longitude, EECFI::TimeCorrelationData::polarMotionFormula, EECFI::TimeCorrelationData::polarMotionParams, EECFI::TimeCorrelationData::predictionFirstRecord, EECFI::TimeData::tai_gps, EECFI::TimeData::tai_ut1, EECFI::TimeData::tai_utc, EECFI::TimeData::taiTime, EECFI::TimeCorrelationData::timeCorrelationFormula, EECFI::TimeCorrelationData::timeCorrVector, EECFI::TimeData::ut1Time, EECFI::LaunchInertialFrameConfig::utcTime, EECFI::LeapSecondInfo::utcTime, EECFI::PolarMotionParams::x, and EECFI::PolarMotionParams::y.

void EECFI::TimeCorrelation::getLeapSecondInfo ( long  asciiFormat,
long &  leapFlag,
std::string &  UtcTimeBeforeLeap,
std::string &  UtcTimeAfterLeap 
) const

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.

References EECFI::CfiClass::throwWarn.

TimeCorrelation & EECFI::TimeCorrelation::operator= ( const TimeCorrelation &  other  ) 

Copy assignment operator.

Parameters:
other The TimeCorrelation to copy/assign from

References EECFI::CfiId::addInstance().

void EECFI::TimeCorrelation::setData ( const TimeCorrelationData &  timeCorr  ) 

Set data (the TimeCorrelation object has to be initialized).

Parameters:
timeCorr Time correlation data.

References EECFI::TimeCorrelationFormula::a, EECFI::PolarMotionFormula::Adiv, EECFI::PolarMotionFormula::Aref, EECFI::PolarMotionFormula::ax, EECFI::PolarMotionFormula::ay, EECFI::TimeCorrelationFormula::b, EECFI::TimeCorrelationFormula::bRef, EECFI::PolarMotionFormula::bx, EECFI::PolarMotionFormula::by, EECFI::PolarMotionFormula::Cdiv, EECFI::PolarMotionFormula::Cref, EECFI::PolarMotionFormula::cx, EECFI::PolarMotionFormula::cy, EECFI::PolarMotionFormula::dx, EECFI::PolarMotionFormula::dy, EECFI::LaunchInertialFrameConfig::enabledFlag, EECFI::PolarMotionFormula::ex, EECFI::PolarMotionFormula::ey, EECFI::LeapSecondInfo::flag, EECFI::TimeCorrelationData::iersBulletinType, EECFI::TimeCorrelationData::iersFormulaFlag, EECFI::TimeCorrelationData::launchInertialFrameConfig, EECFI::TimeCorrelationData::leapSecond, EECFI::LaunchInertialFrameConfig::longitude, EECFI::TimeCorrelationData::polarMotionFormula, EECFI::TimeCorrelationData::polarMotionParams, EECFI::TimeCorrelationData::predictionFirstRecord, EECFI::TimeCorrelationData::timeCorrelationFormula, EECFI::TimeCorrelationData::timeCorrVector, EECFI::LaunchInertialFrameConfig::utcTime, and EECFI::LeapSecondInfo::utcTime.

Referenced by TimeCorrelation().

Generated on Mon Dec 11 2023 13:28:22 for by doxygen 1.7.1