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

Last change on this file since 775 was 775, checked in by mhnguyen, 6 years ago

Implementing the reading of attributes of an axis from a file

+) 3d grid can be read directly from a file
+) Clean some redundant codes
+) Add new attribute declaration that allows to output only desired attributes

Test
+) On Curie
+) test_remap passes and result is correct

  • 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.2 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
15
16
17namespace xios {
18
19   /// ////////////////////// Déclarations ////////////////////// ///
20
21   class CFileGroup;
22   class CFileAttributes;
23   class CFile;
24
25   class CGarbageCollector;
26
27   ///--------------------------------------------------------------
28
29   // Declare/Define CFileAttribute
30   BEGIN_DECLARE_ATTRIBUTE_MAP(CFile)
31#  include "file_attribute.conf"
32   END_DECLARE_ATTRIBUTE_MAP(CFile)
33
34   ///--------------------------------------------------------------
35
36   /*!
37   \class CFile
38   This class corresponds to file component of the xml.
39   The class contains all the nessceary information to write data into a netcdf file: The most important thing
40   is the field(s) which will be written into file. Besides, there are some options to write
41   data into file, e.g: writting into only one file or multiple file; splitting a running into several files.
42   Moreover, there are some other attributes of netcdf file which are also stored in this class
43   */
44   class CFile
45      : public CObjectTemplate<CFile>
46      , public CFileAttributes
47   {
48         /// typedef ///
49         typedef CObjectTemplate<CFile>   SuperClass;
50         typedef CFileAttributes SuperClassAttribute;
51
52      public :
53         enum EEventId
54         {
55           EVENT_ID_ADD_FIELD, EVENT_ID_ADD_FIELD_GROUP, EVENT_ID_ADD_VARIABLE,
56           EVENT_ID_ADD_VARIABLE_GROUP, EVENT_ID_CREATE_ENABLED_FIELDS
57         };
58
59         typedef CFileAttributes RelAttributes;
60         typedef CFileGroup      RelGroup;
61
62         /// Constructeurs ///
63         CFile(void);
64         explicit CFile(const StdString& id);
65         CFile(const CFile& file);       // Not implemented yet.
66         CFile(const CFile* const file); // Not implemented yet.
67
68         /// Destructeur ///
69         virtual ~CFile(void);
70
71      public:
72         /// Accesseurs ///
73         const StdString& getFileOutputName(void) const;
74         boost::shared_ptr<CDataOutput> getDataOutput(void) const;
75         boost::shared_ptr<CDataInput> getDataInput(void) const;
76         CFieldGroup* getVirtualFieldGroup(void) const;
77         CVariableGroup* getVirtualVariableGroup(void) const;
78         std::vector<CField*> getAllFields(void) const;
79         std::vector<CVariable*> getAllVariables(void) const;
80
81         std::vector<CField* > getEnabledFields(int default_outputlevel = 5,
82                                                int default_level = 1,
83                                                bool default_enabled = true);
84
85      public :
86         // Some functions to verify state of file
87         bool isSyncTime(void);
88         bool checkSplit(void);
89         bool checkSync(void);
90         void checkFile(void);
91         void initFile(void);
92
93         /// Mutateurs ///
94         // Set some root definitions in a file
95         void setVirtualFieldGroup(CFieldGroup* newVFieldGroup);
96         void setVirtualFieldGroup(void);
97         void setVirtualVariableGroup(CVariableGroup* newVVariableGroup);
98         void setVirtualVariableGroup(void);
99
100         void createHeader(void);
101         void openInReadMode(void);
102         void close(void);
103         void readAttributesOfEnabledFieldsInReadMode();
104
105         // Some processing on file
106         void solveFieldRefInheritance(bool apply);
107         void processEnabledFile(void);
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.