source: XIOS/trunk/src/io/nc4_data_output.hpp @ 802

Last change on this file since 802 was 802, checked in by rlacroix, 8 years ago

Add a new file attribute time_counter_name.

Users can now modify the name of the time counter dimension and axis name.
  • Property copyright set to
    Software name : XIOS (Xml I/O Server)
    http://forge.ipsl.jussieu.fr/ioserver
    Creation date : January 2009
    Licence : CeCCIL version2
    see license file in root directory : Licence_CeCILL_V2-en.txt
    or http://www.cecill.info/licences/Licence_CeCILL_V2-en.html
    Holder : CEA/LSCE (Laboratoire des Sciences du CLimat et de l'Environnement)
    CNRS/IPSL (Institut Pierre Simon Laplace)
    Project Manager : Yann Meurdesoif
    yann.meurdesoif@cea.fr
File size: 5.2 KB
Line 
1#ifndef __XIOS_NC4_DATA_OUTPUT__
2#define __XIOS_NC4_DATA_OUTPUT__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "onetcdf4.hpp"
7#include "data_output.hpp"
8
9namespace xios
10{
11      /// ////////////////////// Déclarations ////////////////////// ///
12
13      class CNc4DataOutput
14         : protected CONetCDF4
15         , public virtual CDataOutput
16      {
17         public :
18
19            /// Définition de type ///
20            typedef CONetCDF4   SuperClassWriter;
21            typedef CDataOutput SuperClass;
22
23            /// Constructeurs ///
24            CNc4DataOutput
25               (const StdString & filename, bool exist);
26            CNc4DataOutput
27               (const StdString & filename, bool exist, bool useClassicFormat,
28                MPI_Comm comm_file, bool multifile, bool isCollective = true,
29                const StdString& timeCounterName = "time_counter");
30
31            CNc4DataOutput(const CNc4DataOutput & dataoutput);       // Not implemented.
32            CNc4DataOutput(const CNc4DataOutput * const dataoutput); // Not implemented.
33
34            /// Accesseur ///
35            const StdString & getFileName(void) const;
36
37            /// Destructeur ///
38            virtual ~CNc4DataOutput(void);
39            bool singleDomain ;
40            bool isCollective ;
41         protected :
42
43            /// Ecriture ///
44            virtual void writeDomain_   (CDomain* domain);
45            virtual void writeAxis_     (CAxis* axis);
46            virtual void writeGridCompressed_(CGrid* grid);
47            virtual void writeTimeDimension_(void);
48            virtual void writeField_    (CField* field);
49            virtual void writeAttribute_(CVariable* var);
50            virtual void writeAttribute_(CVariable* var, const string& fieldId);
51            virtual void writeFieldData_(CField* field);
52            virtual void writeFile_     (CFile* file);
53            virtual void closeFile_     (void);
54            virtual void syncFile_      (void);
55            virtual void writeTimeAxis_ (CField* field,
56                                         const boost::shared_ptr<CCalendar> cal);
57
58         protected :
59            void writeUnstructuredDomain (CDomain* domain);
60            void writeLocalAttributes(int ibegin, int ni, int jbegin, int nj, StdString domid);
61            void writeLocalAttributes_IOIPSL(const StdString& dimXid, const StdString& dimYid,
62                                             int ibegin, int ni, int jbegin, int nj, int ni_glo, int nj_glo, int rank, int size);
63            void writeTimeAxisAttributes(const StdString & axis_name,
64                                         const StdString & calendar,
65                                         const StdString & units,
66                                         const StdString & time_origin,
67                                         const StdString & time_bounds   = StdString("bounds"),
68                                         const StdString & standard_name = StdString("time"),
69                                         const StdString & long_name     = StdString("Time axis"));
70
71            void writeFileAttributes(const StdString & name,
72                                     const StdString & description,
73                                     const StdString & conventions,
74                                     const StdString & production,
75                                     const StdString & timeStamp);
76
77            void writeMaskAttributes(const StdString & mask_name,
78                                     int data_dim,
79                                     int data_ni     = 0,
80                                     int data_nj     = 0,
81                                     int data_ibegin = 0,
82                                     int data_jbegin = 0);
83
84            void writeAxisAttributes(const StdString & axis_name,
85                                     const StdString & axis,
86                                     const StdString & standard_name,
87                                     const StdString & long_name,
88                                     const StdString & units,
89                                     const StdString & nav_model);
90
91            StdSize getRecordFromTime(Time time);
92
93         private :
94
95            /// Traitement ///
96            StdString getTimeStamp(void) const;
97
98            bool isWrittenDomain(const std::string& domainName) const;
99            bool isWrittenCompressedDomain(const std::string& domainName) const;
100            bool isWrittenAxis(const std::string& axisName) const;
101            bool isWrittenCompressedAxis(const std::string& axisName) const;
102
103            void setWrittenDomain(const std::string& domainName);
104            void setWrittenCompressedDomain(const std::string& domainName);
105            void setWrittenAxis(const std::string& axisName);
106            void setWrittenCompressedAxis(const std::string& axisName);
107
108            /// Propriétés privées ///
109            MPI_Comm comm_file;
110            const StdString filename;
111            std::map<Time, StdSize> timeToRecordCache;
112
113            std::set<std::string> writtenDomains, writtenCompressedDomains;
114            std::set<std::string> writtenAxis, writtenCompressedAxis;
115      }; // class CNc4DataOutput
116
117} // namespace xios
118
119#endif //__XIOS_NC4_DATA_OUTPUT__
Note: See TracBrowser for help on using the repository browser.