source: XIOS/dev/dev_trunk_omp/src/node/file.hpp @ 1646

Last change on this file since 1646 was 1646, checked in by yushan, 5 years ago

branch merged with trunk @1645. arch file (ep&mpi) added for ADA

  • 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: 7.3 KB
Line 
1#ifndef __XIOS_CFile__
2#define __XIOS_CFile__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "mpi_std.hpp"
7#include "field.hpp"
8#include "data_output.hpp"
9#include "data_input.hpp"
10#include "declare_group.hpp"
11#include "date.hpp"
12#include "attribute_enum.hpp"
13#include "attribute_enum_impl.hpp"
14#include "context_client.hpp"
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         std::shared_ptr<CDataOutput> getDataOutput(void) const;
75         std::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         StdString dumpClassAttributes(void);
86
87      public :
88         // Some functions to verify state of file
89         bool isSyncTime(void);
90         bool checkSplit(void);
91         bool checkSync(void);
92         void checkWriteFile(void);
93         void checkReadFile(void);
94         void initWrite(void);
95         void initRead(void);
96         bool isEmptyZone();
97
98         /// Mutateurs ///
99         // Set some root definitions in a file
100         void setVirtualFieldGroup(CFieldGroup* newVFieldGroup);
101         void setVirtualVariableGroup(CVariableGroup* newVVariableGroup);
102
103         void createHeader(void);
104         void openInReadMode(void);
105         void close(void);
106         void readAttributesOfEnabledFieldsInReadMode();
107
108         // Some processing on file
109         void solveFieldRefInheritance(bool apply);
110         void processEnabledFile(void);
111         void solveOnlyRefOfEnabledFields(bool sendToServer);
112         void generateNewTransformationGridDest();
113         
114         void buildFilterGraphOfEnabledFields(CGarbageCollector& gc);
115         void postProcessFilterGraph();
116         void prefetchEnabledReadModeFields();
117         void doPreTimestepOperationsForEnabledReadModeFields();
118         void doPostTimestepOperationsForEnabledReadModeFields();
119
120         void solveAllRefOfEnabledFieldsAndTransform(bool sendToServer);
121         void checkGridOfEnabledFields();
122         void sendGridOfEnabledFields();
123         void sendGridComponentOfEnabledFields();
124
125         void sortEnabledFieldsForUgrid();
126
127         // Add component into file
128         CField* addField(const string& id = "");
129         CFieldGroup* addFieldGroup(const string& id = "");
130         CVariable* addVariable(const string& id = "");
131         CVariableGroup* addVariableGroup(const string& id = "");
132         void setContextClient(CContextClient* newContextClient);
133         CContextClient* getContextClient();
134
135         void setReadContextClient(CContextClient* newContextClient);
136         CContextClient* getReadContextClient();
137
138         // Send info to server         
139         void sendEnabledFields(CContextClient* client);         
140         void sendAddField(const string& id, CContextClient* client);         
141         void sendAddFieldGroup(const string& id, CContextClient* client);                           
142         void sendAddVariable(const string& id, CContextClient* client);
143         void sendAddVariableGroup(const string& id, CContextClient* client);
144         void sendAddAllVariables(CContextClient* client);
145         
146         // Receive info from client
147         static void recvAddField(CEventServer& event);
148         void recvAddField(CBufferIn& buffer);
149         static void recvAddFieldGroup(CEventServer& event);
150         void recvAddFieldGroup(CBufferIn& buffer);
151         static void recvAddVariable(CEventServer& event);
152         void recvAddVariable(CBufferIn& buffer);
153         static void recvAddVariableGroup(CEventServer& event);
154         void recvAddVariableGroup(CBufferIn& buffer);
155
156         // Dispatch event
157         static bool dispatchEvent(CEventServer& event);
158
159      public:
160         /// Accesseurs statiques ///
161         static StdString GetName(void);
162         static StdString GetDefName(void);
163
164         static ENodeType GetType(void);
165      public:
166         /// Traitements ///
167         virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0);
168
169          /// Autres ///
170         virtual void parse(xml::CXMLNode& node);
171         virtual StdString toString(void) const;
172      public:
173
174         CDate lastSync;
175         CDate lastSplit;
176         int nbAxis, nbDomains;
177         bool isOpen;         
178         ep_lib::MPI_Comm fileComm;
179
180      private:
181         void createSubComFile();
182         bool checkRead;
183         bool allZoneEmpty;
184         
185      private :
186         /// Propriétés privées ///
187         CContextClient* client;
188         CContextClient* read_client; // Context client for reading (channel between server 1 and client)
189         CFieldGroup* vFieldGroup;
190         CVariableGroup* vVariableGroup;
191         std::shared_ptr<CDataOutput> data_out;
192         std::shared_ptr<CDataInput> data_in;
193         std::vector<CField*> enabledFields;
194
195
196      public:
197        //         virtual void toBinary  (StdOStream& os) const;
198        //         virtual void fromBinary(StdIStream& is);
199
200   }; // class CFile
201
202   ///--------------------------------------------------------------
203
204   // Declare/Define CFileGroup and CFileDefinition
205   DECLARE_GROUP(CFile);
206
207   ///--------------------------------------------------------------
208
209} // namespace xios
210
211#endif // __XIOS_CFile__
Note: See TracBrowser for help on using the repository browser.