source: XIOS/trunk/src/node/file.hpp @ 878

Last change on this file since 878 was 878, checked in by oabramkina, 5 years ago

Sequential version for UGRID norms. File attribute "convention" has been added with two possible values "CF" and "UGRID". The default value is "CF".

  • 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: 6.3 KB
Line 
1#ifndef __XIOS_CFile__
2#define __XIOS_CFile__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "field.hpp"
7#include "data_output.hpp"
8#include "data_input.hpp"
9#include "declare_group.hpp"
10#include "date.hpp"
11#include "attribute_enum.hpp"
12#include "attribute_enum_impl.hpp"
13#include "mpi.hpp"
14
15namespace xios {
16
17   /// ////////////////////// Déclarations ////////////////////// ///
18
19   class CFileGroup;
20   class CFileAttributes;
21   class CFile;
22
23   class CGarbageCollector;
24
25   ///--------------------------------------------------------------
26
27   // Declare/Define CFileAttribute
28   BEGIN_DECLARE_ATTRIBUTE_MAP(CFile)
29#  include "file_attribute.conf"
30   END_DECLARE_ATTRIBUTE_MAP(CFile)
31
32   ///--------------------------------------------------------------
33
34   /*!
35   \class CFile
36   This class corresponds to file component of the xml.
37   The class contains all the nessceary information to write data into a netcdf file: The most important thing
38   is the field(s) which will be written into file. Besides, there are some options to write
39   data into file, e.g: writting into only one file or multiple file; splitting a running into several files.
40   Moreover, there are some other attributes of netcdf file which are also stored in this class
41   */
42   class CFile
43      : public CObjectTemplate<CFile>
44      , public CFileAttributes
45   {
46         /// typedef ///
47         typedef CObjectTemplate<CFile>   SuperClass;
48         typedef CFileAttributes SuperClassAttribute;
49
50      public :
51         enum EEventId
52         {
53           EVENT_ID_ADD_FIELD, EVENT_ID_ADD_FIELD_GROUP, EVENT_ID_ADD_VARIABLE,
54           EVENT_ID_ADD_VARIABLE_GROUP, EVENT_ID_CREATE_ENABLED_FIELDS
55         };
56
57         typedef CFileAttributes RelAttributes;
58         typedef CFileGroup      RelGroup;
59
60         /// Constructeurs ///
61         CFile(void);
62         explicit CFile(const StdString& id);
63         CFile(const CFile& file);       // Not implemented yet.
64         CFile(const CFile* const file); // Not implemented yet.
65
66         /// Destructeur ///
67         virtual ~CFile(void);
68
69      public:
70         /// Accesseurs ///
71         const StdString& getFileOutputName(void) const;
72         boost::shared_ptr<CDataOutput> getDataOutput(void) const;
73         boost::shared_ptr<CDataInput> getDataInput(void) const;
74         CFieldGroup* getVirtualFieldGroup(void) const;
75         CVariableGroup* getVirtualVariableGroup(void) const;
76         std::vector<CField*> getAllFields(void) const;
77         std::vector<CVariable*> getAllVariables(void) const;
78
79         std::vector<CField* > getEnabledFields(int default_outputlevel = 5,
80                                                int default_level = 1,
81                                                bool default_enabled = true);
82
83      public :
84         // Some functions to verify state of file
85         bool isSyncTime(void);
86         bool checkSplit(void);
87         bool checkSync(void);
88         void checkFile(void);
89         void initFile(void);
90
91         /// Mutateurs ///
92         // Set some root definitions in a file
93         void setVirtualFieldGroup(CFieldGroup* newVFieldGroup);
94         void setVirtualFieldGroup(void);
95         void setVirtualVariableGroup(CVariableGroup* newVVariableGroup);
96         void setVirtualVariableGroup(void);
97
98         void createHeader(void);
99         void openInReadMode(void);
100         void close(void);
101         void readAttributesOfEnabledFieldsInReadMode();
102
103         // Some processing on file
104         void solveFieldRefInheritance(bool apply);
105         void processEnabledFile(void);
106         void solveOnlyRefOfEnabledFields(bool sendToServer);
107         void generateNewTransformationGridDest();
108         void solveAllRefOfEnabledFields(bool sendToServer);
109         void buildFilterGraphOfEnabledFields(CGarbageCollector& gc);
110         void prefetchEnabledReadModeFields();
111         void prefetchEnabledReadModeFieldsIfNeeded();
112
113         // Add component into file
114         CField* addField(const string& id = "");
115         CFieldGroup* addFieldGroup(const string& id = "");
116         CVariable* addVariable(const string& id = "");
117         CVariableGroup* addVariableGroup(const string& id = "");
118
119         // Send info to serever
120         void sendEnabledFields();
121         void sendAddField(const string& id = "");
122         void sendAddFieldGroup(const string& id = "");
123         void sendAddAllVariables();
124         void sendAddVariable(const string& id = "");
125         void sendAddVariableGroup(const string& id = "");
126
127         // Receive info from client
128         static void recvAddField(CEventServer& event);
129         void recvAddField(CBufferIn& buffer);
130         static void recvAddFieldGroup(CEventServer& event);
131         void recvAddFieldGroup(CBufferIn& buffer);
132         static void recvAddVariable(CEventServer& event);
133         void recvAddVariable(CBufferIn& buffer);
134         static void recvAddVariableGroup(CEventServer& event);
135         void recvAddVariableGroup(CBufferIn& buffer);
136
137         // Dispatch event
138         static bool dispatchEvent(CEventServer& event);
139
140      public:
141         /// Accesseurs statiques ///
142         static StdString GetName(void);
143         static StdString GetDefName(void);
144
145         static ENodeType GetType(void);
146      public:
147         /// Traitements ///
148         virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0);
149
150          /// Autres ///
151         virtual void parse(xml::CXMLNode& node);
152         virtual StdString toString(void) const;
153      public:
154
155         CDate lastSync;
156         CDate lastSplit;
157         int nbAxis, nbDomains;
158         bool isOpen;
159         bool allDomainEmpty;
160         MPI_Comm fileComm;
161
162      private :
163         /// Propriétés privées ///
164         CFieldGroup* vFieldGroup;
165         CVariableGroup* vVariableGroup;
166         boost::shared_ptr<CDataOutput> data_out;
167         boost::shared_ptr<CDataInput> data_in;
168         std::vector<CField*> enabledFields;
169
170      public:
171        //         virtual void toBinary  (StdOStream& os) const;
172        //         virtual void fromBinary(StdIStream& is);
173
174   }; // class CFile
175
176   ///--------------------------------------------------------------
177
178   // Declare/Define CFileGroup and CFileDefinition
179   DECLARE_GROUP(CFile);
180
181   ///--------------------------------------------------------------
182
183} // namespace xios
184
185#endif // __XIOS_CFile__
Note: See TracBrowser for help on using the repository browser.