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

Last change on this file since 773 was 773, checked in by rlacroix, 5 years ago

File/Variable?: Add an helper function to get the output 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: 6.1 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
104         // Some processing on file
105         void solveFieldRefInheritance(bool apply);
106         void processEnabledFile(void);
107         void solveAllRefOfEnabledFields(bool sendToServer);
108         void buildFilterGraphOfEnabledFields(CGarbageCollector& gc);
109         void prefetchEnabledReadModeFields();
110         void prefetchEnabledReadModeFieldsIfNeeded();
111
112         // Add component into file
113         CField* addField(const string& id = "");
114         CFieldGroup* addFieldGroup(const string& id = "");
115         CVariable* addVariable(const string& id = "");
116         CVariableGroup* addVariableGroup(const string& id = "");
117
118         // Send info to serever
119         void sendEnabledFields();
120         void sendAddField(const string& id = "");
121         void sendAddFieldGroup(const string& id = "");
122         void sendAddAllVariables();
123         void sendAddVariable(const string& id = "");
124         void sendAddVariableGroup(const string& id = "");
125
126         // Receive info from client
127         static void recvAddField(CEventServer& event);
128         void recvAddField(CBufferIn& buffer);
129         static void recvAddFieldGroup(CEventServer& event);
130         void recvAddFieldGroup(CBufferIn& buffer);
131         static void recvAddVariable(CEventServer& event);
132         void recvAddVariable(CBufferIn& buffer);
133         static void recvAddVariableGroup(CEventServer& event);
134         void recvAddVariableGroup(CBufferIn& buffer);
135
136         // Dispatch event
137         static bool dispatchEvent(CEventServer& event);
138
139      public:
140         /// Accesseurs statiques ///
141         static StdString GetName(void);
142         static StdString GetDefName(void);
143
144         static ENodeType GetType(void);
145      public:
146         /// Traitements ///
147         virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0);
148
149          /// Autres ///
150         virtual void parse(xml::CXMLNode& node);
151         virtual StdString toString(void) const;
152      public:
153
154         CDate lastSync;
155         CDate lastSplit;
156         int nbAxis, nbDomains;
157         bool isOpen;
158         bool allDomainEmpty;
159         MPI_Comm fileComm;
160
161      private :
162         /// Propriétés privées ///
163         CFieldGroup* vFieldGroup;
164         CVariableGroup* vVariableGroup;
165         boost::shared_ptr<CDataOutput> data_out;
166         boost::shared_ptr<CDataInput> data_in;
167         std::vector<CField*> enabledFields;
168
169      public:
170        //         virtual void toBinary  (StdOStream& os) const;
171        //         virtual void fromBinary(StdIStream& is);
172
173   }; // class CFile
174
175   ///--------------------------------------------------------------
176
177   // Declare/Define CFileGroup and CFileDefinition
178   DECLARE_GROUP(CFile);
179
180   ///--------------------------------------------------------------
181
182} // namespace xios
183
184#endif // __XIOS_CFile__
Note: See TracBrowser for help on using the repository browser.