source: XIOS/dev/XIOS_DEV_CMIP6/src/node/field.hpp @ 1278

Last change on this file since 1278 was 1278, checked in by oabramkina, 4 years ago

Adding a check on field attributes. For now it only concerns freq_op and freq_offset.
It is done so to avoid changing its values on client after the attributes have already been sent to servers.

  • 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
  • Property svn:executable set to *
File size: 9.9 KB
Line 
1#ifndef __XIOS_CField__
2#define __XIOS_CField__
3
4/// XIOS headers ///
5#include "xios_spl.hpp"
6#include "group_factory.hpp"
7#include "functor.hpp"
8#include "functor_type.hpp"
9#include "duration.hpp"
10#include "date.hpp"
11#include "declare_group.hpp"
12#include "calendar_util.hpp"
13#include "array_new.hpp"
14#include "attribute_array.hpp"
15#include "declare_ref_func.hpp"
16#include "transformation_enum.hpp"
17#include "variable.hpp"
18#include "context_client.hpp"
19
20
21namespace xios {
22
23   /// ////////////////////// Déclarations ////////////////////// ///
24
25   class CFieldGroup;
26   class CFieldAttributes;
27   class CField;
28
29   class CFile;
30   class CGrid;
31   class CContext;
32   class CGenericFilter;
33
34   class CGarbageCollector;
35   class COutputPin;
36   class CSourceFilter;
37   class CStoreFilter;
38   class CFileWriterFilter;
39   class CFileServerWriterFilter;
40
41   ///--------------------------------------------------------------
42
43   // Declare/Define CFieldAttribute
44   BEGIN_DECLARE_ATTRIBUTE_MAP(CField)
45#  include "field_attribute.conf"
46   END_DECLARE_ATTRIBUTE_MAP(CField)
47
48   ///--------------------------------------------------------------
49   class CField
50      : public CObjectTemplate<CField>
51      , public CFieldAttributes
52   {
53         /// friend ///
54         friend class CFile;
55
56         /// typedef ///
57         typedef CObjectTemplate<CField>   SuperClass;
58         typedef CFieldAttributes SuperClassAttribute;
59
60         enum EReadField
61         {
62           RF_NODATA, RF_EOF, RF_DATA
63         };
64         
65      public:
66
67         typedef CFieldAttributes RelAttributes;
68         typedef CFieldGroup      RelGroup;
69
70         enum EEventId
71         {
72           EVENT_ID_UPDATE_DATA, EVENT_ID_READ_DATA, EVENT_ID_READ_DATA_READY,
73           EVENT_ID_ADD_VARIABLE, EVENT_ID_ADD_VARIABLE_GROUP
74         };
75
76         /// Constructeurs ///
77         CField(void);
78         explicit CField(const StdString& id);
79         CField(const CField& field);       // Not implemented yet.
80         CField(const CField* const field); // Not implemented yet.
81
82         /// Accesseurs ///
83
84         CGrid* getRelGrid(void) const;
85         CFile* getRelFile(void) const;
86
87         func::CFunctor::ETimeType getOperationTimeType() const;
88
89      public:
90         int getNStep(void) const;
91
92         template <int N> void getData(CArray<double, N>& _data) const;
93
94         boost::shared_ptr<COutputPin> getInstantDataFilter();
95
96         /// Mutateur ///
97         void setRelFile(CFile* _file);
98         void incrementNStep(void);
99         void resetNStep(int nstep = 0);
100         void resetNStepMax();
101
102         std::map<int, StdSize> getGridAttributesBufferSize(CContextClient* client);
103         std::map<int, StdSize> getGridDataBufferSize(CContextClient* client); // Grid data buffer size for each connection of contextclient
104
105       public:
106         bool isActive(bool atCurrentTimestep = false) const;
107         bool hasOutputFile;
108
109         bool wasWritten() const;
110         void setWritten();
111
112         bool getUseCompressedOutput() const;
113         void setUseCompressedOutput();
114
115         /// Traitements ///
116         void solveGridReference(void);
117         void solveServerOperation(void);
118         void solveCheckMaskIndex(bool doSendingIndex);
119         void solveAllReferenceEnabledField(bool doSending2Server);
120         void solveOnlyReferenceEnabledField(bool doSending2Server);
121         void generateNewTransformationGridDest();
122         void updateRef(CGrid* grid);
123         void buildGridTransformationGraph();
124         void solveGridDomainAxisRef(bool checkAtt);
125         void solveTransformedGrid();
126         void solveGenerateGrid();
127         void solveGridDomainAxisBaseRef();
128
129         void solveAllEnabledFieldsAndTransform();
130         void checkGridOfEnabledFields();
131         void sendGridOfEnabledFields();
132         void sendGridComponentOfEnabledFields();
133
134         /// Vérifications ///
135         void checkAttributes(void);
136
137         void buildFilterGraph(CGarbageCollector& gc, bool enableOutput);
138         size_t getGlobalWrittenSize(void) ;
139         
140         
141         boost::shared_ptr<COutputPin> getFieldReference(CGarbageCollector& gc);
142         boost::shared_ptr<COutputPin> getSelfReference(CGarbageCollector& gc);
143         boost::shared_ptr<COutputPin> getTemporalDataFilter(CGarbageCollector& gc, CDuration outFreq);
144         boost::shared_ptr<COutputPin> getSelfTemporalDataFilter(CGarbageCollector& gc, CDuration outFreq);
145
146//         virtual void fromBinary(StdIStream& is);
147
148         /// Destructeur ///
149         virtual ~CField(void);
150
151         /// Accesseurs statiques ///
152         static StdString GetName(void);
153         static StdString GetDefName(void);
154
155         static ENodeType GetType(void);
156
157        template <int N> void setData(const CArray<double, N>& _data);
158        static bool dispatchEvent(CEventServer& event);
159        void sendUpdateData(const CArray<double,1>& data);
160        void sendUpdateData(const CArray<double,1>& data, CContextClient* client);
161        static void recvUpdateData(CEventServer& event);
162        void recvUpdateData(std::map<int,CBufferIn*>& rankBuffers);
163        void writeField(void);
164        bool sendReadDataRequest(const CDate& tsDataRequested);
165        bool sendReadDataRequestIfNeeded(void);
166        static void recvReadDataRequest(CEventServer& event);
167        void recvReadDataRequest(void);
168        EReadField readField(void);
169        static void recvReadDataReady(CEventServer& event);
170        void recvReadDataReady(vector<int> ranks, vector<CBufferIn*> buffers);
171        void outputField(CArray<double,3>& fieldOut);
172        void outputField(CArray<double,2>& fieldOut);
173        void outputField(CArray<double,1>& fieldOut);
174        void inputField(CArray<double,3>& fieldOut);
175        void inputField(CArray<double,2>& fieldOut);
176        void inputField(CArray<double,1>& fieldOut);
177        void outputCompressedField(CArray<double, 1>& fieldOut);
178        void scaleFactorAddOffset(double scaleFactor, double addOffset);
179        void invertScaleFactorAddOffset(double scaleFactor, double addOffset);
180        void parse(xml::CXMLNode& node);
181
182        void setVirtualVariableGroup(CVariableGroup* newVVariableGroup);
183        CVariableGroup* getVirtualVariableGroup(void) const;
184        vector<CVariable*> getAllVariables(void) const;
185        virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0);
186
187        CVariable* addVariable(const string& id = "");
188        CVariableGroup* addVariableGroup(const string& id = "");       
189        void sendAddVariable(const string& id, CContextClient* client);
190        void sendAddVariableGroup(const string& id, CContextClient* client);
191        static void recvAddVariable(CEventServer& event);
192        void recvAddVariable(CBufferIn& buffer);
193        static void recvAddVariableGroup(CEventServer& event);
194        void recvAddVariableGroup(CBufferIn& buffer);       
195        void sendAddAllVariables(CContextClient* client);
196        void writeUpdateData(const CArray<double,1>& data);
197
198        const std::vector<StdString>& getRefDomainAxisIds();
199
200        const string& getExpression(void);
201        bool hasExpression(void) const;
202
203      public:
204         /// Propriétés privées ///
205         CVariableGroup* vVariableGroup;
206
207         CGrid*  grid;
208         CFile*  file;
209
210         CDuration freq_operation_srv, freq_write_srv;
211
212         bool written; //<! Was the field written at least once
213         int nstep, nstepMax;
214         bool isEOF;
215         CDate lastlast_Write_srv, last_Write_srv, last_operation_srv;
216         CDate lastDataRequestedFromServer, lastDataReceivedFromServer;
217         bool wasDataAlreadyReceivedFromServer;
218
219         map<int,boost::shared_ptr<func::CFunctor> > foperation_srv;
220
221         // map<int, CArray<double,1> > data_srv;
222         CArray<double,1> recvDataSrv;
223         
224         boost::shared_ptr<func::CFunctor> recvFoperationSrv;
225         string content;
226
227         std::vector<StdString> domAxisScalarIds_;
228         bool useCompressedOutput;
229
230         // Two variables to identify the time_counter meta data written in file, which has no time_counter
231         bool hasTimeInstant;
232         bool hasTimeCentered;
233
234
235         DECLARE_REF_FUNC(Field,field)
236
237      private:
238         bool areAllReferenceSolved;
239         bool isReferenceSolved;
240         bool isReferenceSolvedAndTransformed;
241         bool nstepMaxRead;
242
243      private:
244         //! The type of operation attached to the field
245         func::CFunctor::ETimeType operationTimeType;
246
247         //! The output pin of the filter providing the instant data for the field
248         boost::shared_ptr<COutputPin> instantDataFilter;
249         //! The output pin of the filters providing the result of the field's temporal operation
250         std::map<CDuration, boost::shared_ptr<COutputPin>, DurationFakeLessComparator> temporalDataFilters;
251         //! The output pin of the filter providing the instant data for self references
252         boost::shared_ptr<COutputPin> selfReferenceFilter;
253         //! The source filter for data provided by the client
254         boost::shared_ptr<CSourceFilter> clientSourceFilter;
255         //! The source filter for data provided by the server
256         boost::shared_ptr<CSourceFilter> serverSourceFilter;
257         //! The terminal filter which stores the instant data
258         boost::shared_ptr<CStoreFilter> storeFilter;
259         //! The terminal filter which writes the data to file
260         boost::shared_ptr<CFileWriterFilter> fileWriterFilter;
261         //! The terminal filter which writes data to file
262         boost::shared_ptr<CFileServerWriterFilter> fileServerWriterFilter;
263   }; // class CField
264
265   ///--------------------------------------------------------------
266
267   // Declare/Define CFieldGroup and CFieldDefinition
268   DECLARE_GROUP(CField);
269
270   ///-----------------------------------------------------------------
271
272   template <>
273      void CGroupTemplate<CField, CFieldGroup, CFieldAttributes>::solveRefInheritance(void);
274
275   ///-----------------------------------------------------------------
276} // namespace xios
277
278
279#endif // __XIOS_CField__
Note: See TracBrowser for help on using the repository browser.