Earth Observation Mission CFI Software DataHandling Software User Manual |
Code | EO-MA-DMS-GS-012 |
Issue | 4.1 |
Date | 07/05/2010 |
Name | Function | Signature | |
Prepared by: | Carlos Villanueva Muñoz | Project Engineer | |
Checked by: | Juan José Borrego Bote | Project Manager | |
Approved by: | José Antonio González Abeytua | Division Head |
Contract Data | Classification | ||
---|---|---|---|
Contract Number: | 15583/01/NL/GS | Internal | |
Public | |||
Contract Issuer: | ESA / ESTEC | Industry | X |
Confidential |
External Distribution | ||
---|---|---|
Name | Organization | Copies |
Electronic handling | ||
---|---|---|
Document generator: | Doxygen 1.5.8 | |
Electronic file name: | eo-ma-dms-gs-012-10 |
Issue | Change Description | Date | Approval |
---|---|---|---|
1.0 | First release These libraries corresponds to version 4.0 of C libraries. | 27/03/09 | |
4.1 | Second release - Issue in line with C version These libraries corresponds to version 4.1 of C libraries. | 07/05/10 |
ANX | Ascending Node Crossing |
AOCS | Attitude and Orbit Control Subsystem |
ASCII | American Standard Code for Information Interchange |
BOM | Beginning Of Mission |
CFI | Customer Furnished Item |
EOM | End Of Mission |
ESA | European Space Agency |
ESTEC | European Space Technology and Research Centre |
GPL | GNU Public License |
GPS | Global Positioning System |
IERS | International Earth Rotation Service |
I/F | Interface |
LS | Leap Second |
OBT | On-board Binary Time |
OSF | Orbit Scenario File |
SRAR | Satellite Relative Actual Reference |
SUM | Software User Manual |
TAI | International Atomic Time |
UTC | Coordinated Universal Time |
UT1 | Universal Time UT1 |
WGS[84 | World Geodetic System 1984 |
CFI | A group of CFI functions, and related software and documentation. that will be distributed by ESA to the users as an independent unit |
CFI function | A single function within a CFI that can be called by the user |
Library | A software library containing all the CFI functions included within a CFI plus the supporting functions used by those CFI functions (transparently to the user) |
In order to keep compatibility with legacy CFI libraries, the Earth Observation Mission CFI Software makes use of terms that are linked with missions already or soon in the operational phase like the Earth Explorers. This may be reflected in the rest of the document when examples of Mission CFI Software usage are proposed or description of Mission Files is given.
[GEN_SUM] | Earth Observation Mission CFI Software. General Software User Manual. EO-MA-DMS-GS-017. Issue 4.1 07/05/10 |
[MCD] | Earth Observation Mission CFI Software. Conventions Document. EO-MA-DMS-GS-0001. Issue 1.0 27/10/09. |
[EE_COMMON_SUM] | Earth Observation Mission CFI Software. EECommon Software User Manual. EO-MA-DMS-GS-010. Issue 4.1 07/05/10. |
[F_H_SUM] | Earth Observation Mission CFI Software. FileHandling Software User Manual. EO-MA-DMS-GS-011. Issue 4.1 07/05/10. |
[IERS] | http://www.iers.org/iers/publications/bulletins/ |
This software library contains a set of classes for reading and writing Earth Observation Mission Files. The following CFI classes for reading/writing files are included:
The following classes to contain data are also included:
For a detailed description of the installation of any CFI library, please refer to [GEN_SUM].
Note that to use the DATA_HANDLING software library, the following other CFI software libraries are required:
It is needed to have properly installed in the system the following external GPL library:
To use the DATA_HANDLING software library in an user application, that application must include in its source code the header files where the classes that are going to be used are defined.
To link correctly this application, the user must include in his linking command flags like (assuming cfi_lib_dir and cfi_include_dir are the directories where respectively all CFI libraries and include files have been installed, see [GEN_SUM] for installation procedures):
Note that, as Earth Observation CFI libraries are dynamic, cfi_lib_dir must be included in the path where the system looks for dynamic libraries (LD_LIBRARY_PATH in LINUX and SOLARIS, DYLD_LIBRARY_PATH in MacOs). For WINDOWS sytem, the executable will look for .dll libraries, not the .lib ones that are used to create the executable, so they must be in the path described by PATH variable.
All the classes described in this document are defined in EECFI namespace, to avoid any possible conflict with classes of other libraries, so the user must choose one of the following two options in order to use the classes:
Finally, in order to use the function EEFile::validate , it is neccessary the xerces-c 2.7 (or later) dynamic library and the SAX2Count executable program. Both of them are distributed under Apache 2.0 Licence (More information about xerces-c can be found in: http://xml.apache.org/xerces-c/index.html). EEFile::validate internally calls the SAX2Count program, so that in order to find it, the path for SAX2Count and the xerces-c dynamic library has to be included in the environment variable PATH (For LINUX and SOLARIS, the xerces library has to be included in the LD_LIBRARY_PATH instead).
The error management in C++ DATA_HANDLING is made throw exceptions, that is, if any error is produced, an exception of type CfiError is thrown and it must be catched putting the code inside a try-catch block.
See [GEN_SUM] to know more about how to handle the CFI errors. For a descripton about the CfiError class and its methods, see [EE_COMMON_SUM].
Next table shows the available schema's versions for the Earth Observation Missions files at the time of the CFI's package delivery, and which of them are supported by the current CFI's implementation. The meaning of the column "Supp. CFI's" is:
File Type | Version | Supp. CFI's | Schema |
---|---|---|---|
Predicted Orbit File | 1.0 | N | EO_OPER_MPL_ORBPRE_0100.XSD |
1.1 | R | EO_OPER_MPL_ORBPRE_0101.XSD | |
1.2 | Y | EO_OPER_MPL_ORBPRE_0102.XSD | |
Restituted Orbit files | 1.0 | N | EO_OPER_AUX_ORBRES_0100.XSD |
1.1 | R | EO_OPER_AUX_ORBRES_0101.XSD | |
1.2 | Y | EO_OPER_AUX_ORBRES_0102.XSD | |
Doris Preliminary files | 1.0 | N | EO_OPER_AUX_ORBDOP_0100.XSD |
1.1 | R | EO_OPER_AUX_ORBDOP_0101.XSD | |
1.2 | Y | EO_OPER_AUX_ORBDOP_0102.XSD | |
Doris Precise files | 1.0 | N | EO_OPER_AUX_ORBDOR_0100.XSD |
1.1 | R | EO_OPER_AUX_ORBDOR_0101.XSD | |
1.2 | Y | EO_OPER_AUX_ORBDOR_0102.XSD | |
Orbit Scenario files | 1.0 | N | EO_OPER_MPL_ORBSCT_0100.XSD |
1.1 | Y | EO_OPER_MPL_ORBSCT_0101.XSD | |
Orbit Event files | 1.0 | Y | EO_OPER_MPL_ORBREF_0100.XSD |
1.1 | R | EO_OPER_MPL_ORBREF_0101.XSD | |
1.2 | Y | EO_OPER_MPL_ORBREF_0102.XSD | |
DORIS Navigator files | 1.1 | Y | EO_OPER_DOR_NAV_0_.HeaderTypes_0101.XSD with |
Star Tracker files | 1.1 | Y | EO_OPER_STR1ATT_0_HeaderTypes_0101.XSD with |
Satellite Configuration File | 1.0 | N | EO_OPER_INT_SATCFG_0100.XSD |
1.1 | N | EO_OPER_INT_SATCFG_0101.XSD | |
1.2 | Y | EO_OPER_INT_SATCFG_0102.XSD | |
Attitude File | 1.0 | N | EO_OPER_INT_ATTCFG_0100.XSD |
1.1 | Y | EO_OPER_INT_ATTREF_0101.XSD | |
Star tracker configuration File | 1.0 | N | EO_OPER_INT_STRCFG_0100.XSD |
1.1 | Y | EO_OPER_INT_STRCFG_0101.XSD | |
DEM Configuration File | 1.0 | N | EO_OPER_INT_DEMCFG_0100.XSD |
1.1 | Y | EO_OPER_INT_DEMCFG_0101.XSD | |
Swath Definition File | 1.0 | N | EO_OPER_MPL_SW_DEF_0100.XSD |
1.1 | R | EO_OPER_MPL_SW_DEF_0101.XSD | |
2.1 | Y | EO_OPER_MPL_SW_DEF_0201.XSD | |
Swath Template File | 1.0 | N | EO_OPER_MPL_SWTREF_0100.XSD |
1.1 | R | EO_OPER_MPL_SWTREF_0101.XSD | |
2.0 | Y | EO_OPER_MPL_SWTREF_0200.XSD | |
Zone Database File | 1.0 | N | EO_OPER_MPL_ZON_DB_0100.XSD |
1.1 | Y | EO_OPER_MPL_ZON_DB_0101.XSD | |
Station Database File | 1.0 | N | EO_OPER_MPL_GND_DB_0100.XSD |
1.1 | Y | EO_OPER_MPL_GND_DB_0101.XSD | |
1.2 | Y | EO_OPER_MPL_GND_DB_0102.XSD | |
Precise Propagator Configuration File | 1.0 | Y | EO_OPER_INT_PPRCFG_0100.XSD |