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 | #include "pass_through_filter.hpp" |
---|
20 | #include "temporal_filter.hpp" |
---|
21 | #include "model_to_client_source_filter.hpp" |
---|
22 | #include "client_from_client_source_filter.hpp" |
---|
23 | #include "client_from_server_source_filter.hpp" |
---|
24 | #include "client_to_model_store_filter.hpp" |
---|
25 | #include "server_to_client_store_filter.hpp" |
---|
26 | #include "server_from_client_source_filter.hpp" |
---|
27 | #include "file_writer_store_filter.hpp" |
---|
28 | #include "client_to_server_store_filter.hpp" |
---|
29 | #include "file_reader_source_filter.hpp" |
---|
30 | |
---|
31 | |
---|
32 | |
---|
33 | |
---|
34 | |
---|
35 | namespace xios |
---|
36 | { |
---|
37 | |
---|
38 | /// ////////////////////// Déclarations ////////////////////// /// |
---|
39 | |
---|
40 | class CFieldGroup; |
---|
41 | class CFieldAttributes; |
---|
42 | class CField; |
---|
43 | |
---|
44 | class CFile; |
---|
45 | class CCouplerIn ; |
---|
46 | class CCouplerOut ; |
---|
47 | class CGrid; |
---|
48 | class CContext; |
---|
49 | class CGenericFilter; |
---|
50 | |
---|
51 | class CGarbageCollector; |
---|
52 | class COutputPin; |
---|
53 | class CSourceFilter; |
---|
54 | class CServerToClientFilter; |
---|
55 | ///-------------------------------------------------------------- |
---|
56 | |
---|
57 | // Declare/Define CFieldAttribute |
---|
58 | BEGIN_DECLARE_ATTRIBUTE_MAP(CField) |
---|
59 | # include "field_attribute.conf" |
---|
60 | END_DECLARE_ATTRIBUTE_MAP(CField) |
---|
61 | |
---|
62 | class CContextClient ; |
---|
63 | |
---|
64 | ///-------------------------------------------------------------- |
---|
65 | class CField |
---|
66 | : public CObjectTemplate<CField> |
---|
67 | , public CFieldAttributes |
---|
68 | { |
---|
69 | /// friend /// |
---|
70 | friend class CFile; |
---|
71 | |
---|
72 | /// typedef /// |
---|
73 | typedef CObjectTemplate<CField> SuperClass; |
---|
74 | typedef CFieldAttributes SuperClassAttribute; |
---|
75 | |
---|
76 | public : |
---|
77 | enum EReadField |
---|
78 | { |
---|
79 | RF_NODATA, RF_EOF, RF_DATA |
---|
80 | }; |
---|
81 | |
---|
82 | public: |
---|
83 | |
---|
84 | typedef CFieldAttributes RelAttributes; |
---|
85 | typedef CFieldGroup RelGroup; |
---|
86 | |
---|
87 | enum EEventId |
---|
88 | { |
---|
89 | EVENT_ID_UPDATE_DATA, EVENT_ID_READ_DATA, EVENT_ID_READ_DATA_READY, |
---|
90 | EVENT_ID_ADD_VARIABLE, EVENT_ID_ADD_VARIABLE_GROUP, EVENT_ID_GRID_COMPLETED |
---|
91 | }; |
---|
92 | |
---|
93 | /// Constructeurs /// |
---|
94 | CField(void); |
---|
95 | explicit CField(const StdString& id); |
---|
96 | CField(const CField& field); // Not implemented yet. |
---|
97 | CField(const CField* const field); // Not implemented yet. |
---|
98 | |
---|
99 | /// Accesseurs /// |
---|
100 | |
---|
101 | CGrid* getRelGrid(void) const; |
---|
102 | CFile* getRelFile(void) const; |
---|
103 | |
---|
104 | func::CFunctor::ETimeType getOperationTimeType() const; |
---|
105 | |
---|
106 | public: |
---|
107 | template <int N> void getData(CArray<double, N>& _data) const; |
---|
108 | |
---|
109 | std::map<int, StdSize> getGridAttributesBufferSize(CContextClient* client, bool bufferForWriting = false); |
---|
110 | // Grid data buffer size for each connection of contextclient |
---|
111 | std::map<int, StdSize> getGridDataBufferSize(CContextClient* client, bool bufferForWriting = false); |
---|
112 | |
---|
113 | // evaluation the size of the buffer for the field |
---|
114 | bool evaluateBufferSize(map<CContextClient*,map<int,size_t>>& evaluateBuffer, bool isOptPerformance) ; |
---|
115 | public: |
---|
116 | void makeGridAliasForCoupling(void) ; |
---|
117 | public: |
---|
118 | bool isActive(bool atCurrentTimestep = false) const; |
---|
119 | bool hasOutputFile; |
---|
120 | |
---|
121 | bool wasWritten() const; |
---|
122 | void setWritten(); |
---|
123 | |
---|
124 | bool getUseCompressedOutput() const; |
---|
125 | void setUseCompressedOutput(); |
---|
126 | |
---|
127 | /// Traitements /// |
---|
128 | void solveGridReference(void); |
---|
129 | void solveServerOperation(void); |
---|
130 | void solveCheckMaskIndex(bool doSendingIndex); |
---|
131 | void updateRef(CGrid* grid); |
---|
132 | void solveGridDomainAxisRef(bool checkAtt); |
---|
133 | void solveGridDomainAxisBaseRef(); |
---|
134 | |
---|
135 | void checkGridOfEnabledFields(); |
---|
136 | void sendGridOfEnabledFields(); |
---|
137 | void sendGridComponentOfEnabledFields(); |
---|
138 | |
---|
139 | void sendFieldToFileServer(void) ; |
---|
140 | void sendCloseDefinition(void) ; |
---|
141 | |
---|
142 | public: |
---|
143 | void sendFieldToCouplerOut(void) ; |
---|
144 | private: |
---|
145 | bool sendFieldToCouplerOut_done_=false; |
---|
146 | public: |
---|
147 | |
---|
148 | void sendFieldToInputFileServer(void) ; |
---|
149 | |
---|
150 | /// Vérifications /// |
---|
151 | void checkTimeAttributes(CDuration* freqOp=NULL); |
---|
152 | |
---|
153 | bool buildWorkflowGraph(CGarbageCollector& gc) ; |
---|
154 | bool buildWorkflowGraphDone_ = false ; |
---|
155 | |
---|
156 | size_t getGlobalWrittenSize(void) ; |
---|
157 | |
---|
158 | |
---|
159 | std::shared_ptr<COutputPin> getSelfReference(CGarbageCollector& gc); |
---|
160 | std::shared_ptr<COutputPin> getTemporalDataFilter(CGarbageCollector& gc, CDuration outFreq); |
---|
161 | std::shared_ptr<COutputPin> getSelfTemporalDataFilter(CGarbageCollector& gc, CDuration outFreq); |
---|
162 | |
---|
163 | // virtual void fromBinary(StdIStream& is); |
---|
164 | |
---|
165 | /// Destructeur /// |
---|
166 | virtual ~CField(void); |
---|
167 | |
---|
168 | /// Accesseurs statiques /// |
---|
169 | static StdString GetName(void); |
---|
170 | static StdString GetDefName(void); |
---|
171 | |
---|
172 | static ENodeType GetType(void); |
---|
173 | |
---|
174 | template <int N> void setData(const CArray<double, N>& _data); |
---|
175 | static bool dispatchEvent(CEventServer& event); |
---|
176 | void sendAllAttributesToServer(CContextClient* client) ; |
---|
177 | |
---|
178 | static void recvUpdateData(CEventServer& event); |
---|
179 | void receiveUpdateData(CEventServer& event); |
---|
180 | |
---|
181 | bool sendReadDataRequest(const CDate& tsDataRequested); |
---|
182 | bool sendReadDataRequestIfNeeded(void); |
---|
183 | static void recvReadDataRequest(CEventServer& event); |
---|
184 | void recvReadDataRequest(void); |
---|
185 | static void recvReadDataReady(CEventServer& event); |
---|
186 | void receiveReadDataReady(CEventServer& event); |
---|
187 | void recvReadDataReady(vector<int> ranks, vector<CBufferIn*> buffers); // old interface to remove |
---|
188 | void recvDataFromCoupler(vector<int> ranks, vector<CBufferIn*> buffers) ; // old interface to remove |
---|
189 | void checkForLateDataFromServer(void); |
---|
190 | void checkForLateDataFromCoupler(void) ; |
---|
191 | |
---|
192 | void checkIfMustAutoTrigger(void); // ym obsolete |
---|
193 | void autoTriggerIfNeeded(void); //ym obsolete |
---|
194 | void triggerLateField(void) ; |
---|
195 | |
---|
196 | void parse(xml::CXMLNode& node); |
---|
197 | |
---|
198 | void setVirtualVariableGroup(CVariableGroup* newVVariableGroup); |
---|
199 | CVariableGroup* getVirtualVariableGroup(void) const; |
---|
200 | vector<CVariable*> getAllVariables(void) const; |
---|
201 | virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0); |
---|
202 | |
---|
203 | CVariable* addVariable(const string& id = ""); |
---|
204 | CVariableGroup* addVariableGroup(const string& id = ""); |
---|
205 | void sendAddVariable(const string& id, CContextClient* client); |
---|
206 | void sendAddVariableGroup(const string& id, CContextClient* client); |
---|
207 | static void recvAddVariable(CEventServer& event); |
---|
208 | void recvAddVariable(CBufferIn& buffer); |
---|
209 | static void recvAddVariableGroup(CEventServer& event); |
---|
210 | void recvAddVariableGroup(CBufferIn& buffer); |
---|
211 | void sendAddAllVariables(CContextClient* client); |
---|
212 | |
---|
213 | const std::vector<StdString>& getRefDomainAxisIds(); |
---|
214 | |
---|
215 | const string& getExpression(void); |
---|
216 | bool hasExpression(void) const; |
---|
217 | |
---|
218 | bool hasGridMask(void) const; |
---|
219 | |
---|
220 | void connectToFileServer(CGarbageCollector& gc) ; |
---|
221 | void connectToCouplerOut(CGarbageCollector& gc) ; |
---|
222 | void connectToCouplerIn(CGarbageCollector& gc) ; |
---|
223 | void connectToModelInput(CGarbageCollector& gc) ; |
---|
224 | void connectToFileWriter(CGarbageCollector& gc) ; |
---|
225 | void connectToClientInput(CGarbageCollector& gc) ; |
---|
226 | void connectToServerInput(CGarbageCollector& gc) ; |
---|
227 | void connectToModelOutput(CGarbageCollector& gc); |
---|
228 | void connectToFileReader(CGarbageCollector& gc) ; |
---|
229 | void connectToServerToClient(CGarbageCollector& gc) ; |
---|
230 | |
---|
231 | void setContextClientDataBufferSize(map<CContextClient*,map<int,size_t>>& bufferSize, |
---|
232 | map<CContextClient*,map<int,size_t>>& maxEventSize, |
---|
233 | bool bufferForWriting) ; |
---|
234 | void setContextClientAttributesBufferSize(map<CContextClient*,map<int,size_t>>& bufferSize, |
---|
235 | map<CContextClient*,map<int,size_t>>& maxEventSize, |
---|
236 | bool bufferForWriting) ; |
---|
237 | private: |
---|
238 | bool isGridCompleted_ = true ; |
---|
239 | public: |
---|
240 | bool isGridCompleted() ; |
---|
241 | void setGridCompleted(void) { isGridCompleted_= true; } |
---|
242 | void unsetGridCompleted(void) { isGridCompleted_ = false ;} |
---|
243 | |
---|
244 | public: |
---|
245 | void sendGridCompleted(void) ; |
---|
246 | private: |
---|
247 | static void recvGridCompleted(CEventServer& event); |
---|
248 | void recvGridCompleted(CBufferIn& buffer); |
---|
249 | |
---|
250 | |
---|
251 | private: |
---|
252 | std::vector<CGrid*> getGridPath(void) ; |
---|
253 | |
---|
254 | public: |
---|
255 | /// Propriétés privées /// |
---|
256 | CVariableGroup* vVariableGroup; |
---|
257 | |
---|
258 | CGrid* grid_=nullptr; |
---|
259 | CGrid* getGrid(void) { return grid_; } |
---|
260 | |
---|
261 | private: |
---|
262 | CGrid* sentGrid_=nullptr ; |
---|
263 | public: |
---|
264 | CGrid* getSentGrid(void) { return sentGrid_; } |
---|
265 | |
---|
266 | public: |
---|
267 | // CFile* file; |
---|
268 | |
---|
269 | CFile* fileIn_ = nullptr ; //<! pointer to input related file |
---|
270 | bool hasFileIn(void) const { return fileIn_==nullptr ? false : true ;} |
---|
271 | CFile* getFileIn(void) {return fileIn_;} |
---|
272 | void setFileIn(CFile* fileIn) { fileIn_ = fileIn ;} |
---|
273 | void unsetFileIn(void) { fileIn_ = nullptr ;} |
---|
274 | |
---|
275 | CFile* fileOut_ = nullptr ; //<! pointer to output related file |
---|
276 | bool hasFileOut(void) const { return fileOut_==nullptr ? false : true ;} |
---|
277 | CFile* getFileOut(void) {return fileOut_;} |
---|
278 | void setFileOut(CFile* fileOut) { fileOut_ = fileOut ;} |
---|
279 | void unsetFileOut(void) { fileOut_ = nullptr ;} |
---|
280 | |
---|
281 | CCouplerIn* couplerIn_ = nullptr ; //<!pointer to input related coupler |
---|
282 | bool hasCouplerIn(void) const { return couplerIn_==nullptr ? false : true ;} |
---|
283 | CCouplerIn* getCouplerIn(void) {return couplerIn_;} |
---|
284 | void setCouplerIn(CCouplerIn* couplerIn) { couplerIn_ = couplerIn ;} |
---|
285 | void unsetCouplerIn(void) { couplerIn_ = nullptr ;} |
---|
286 | |
---|
287 | CCouplerOut* couplerOut_ = nullptr ; //<!pointer to output related coupler |
---|
288 | bool hasCouplerOut(void) const { return couplerOut_==nullptr ? false : true ;} |
---|
289 | CCouplerOut* getCouplerOut(void) {return couplerOut_;} |
---|
290 | void setCouplerOut(CCouplerOut* couplerOut) { couplerOut_ = couplerOut ;} |
---|
291 | void unsetCouplerOut(void) { couplerOut_ = nullptr ;} |
---|
292 | |
---|
293 | bool modelIn_ = false ; //<! field can be received from model == true |
---|
294 | bool getModelIn(void) { return modelIn_ ;} |
---|
295 | void setModelIn(void) { modelIn_ = true ;} |
---|
296 | void unsetModelIn(void) { modelIn_ = false ;} |
---|
297 | |
---|
298 | bool modelOut_ = false ; //<! field can be retrieve to model == true |
---|
299 | bool getModelOut(void) { return modelOut_ ;} |
---|
300 | void setModelOut(void) { modelOut_ = true ;} |
---|
301 | void unsetModelOut(void) { modelOut_ = false ;} |
---|
302 | |
---|
303 | |
---|
304 | bool written; //<! Was the field written at least once |
---|
305 | bool mustAutoTrigger; |
---|
306 | |
---|
307 | string content; |
---|
308 | |
---|
309 | std::vector<StdString> domAxisScalarIds_; |
---|
310 | bool useCompressedOutput; |
---|
311 | |
---|
312 | // Two variables to identify the time_counter meta data written in file, which has no time_counter |
---|
313 | bool hasTimeInstant; |
---|
314 | bool hasTimeCentered; |
---|
315 | |
---|
316 | |
---|
317 | DECLARE_REF_FUNC(Field,field) |
---|
318 | |
---|
319 | private: |
---|
320 | CContextClient* client; |
---|
321 | public: |
---|
322 | void setContextClient(CContextClient* newContextClient); |
---|
323 | CContextClient* getContextClient(void) {return client;} |
---|
324 | |
---|
325 | private: |
---|
326 | |
---|
327 | bool areAllReferenceSolved; |
---|
328 | bool isReferenceSolved; |
---|
329 | bool isReferenceSolvedAndTransformed; |
---|
330 | bool isGridChecked; |
---|
331 | |
---|
332 | private: |
---|
333 | //! define if the field is part of the active workflow. It will be tagged to true when CField::buildWorkflowGraph is successfull |
---|
334 | bool workflowEnabled_ = false ; |
---|
335 | public: |
---|
336 | /*! workflowEnabled_ public accessor |
---|
337 | * \return Value of workflowEnabled_ */ |
---|
338 | bool getWorkflowEnabled(void) { return workflowEnabled_; } |
---|
339 | |
---|
340 | |
---|
341 | private: |
---|
342 | |
---|
343 | //! The type of operation attached to the field |
---|
344 | func::CFunctor::ETimeType operationTimeType; |
---|
345 | |
---|
346 | //! The output pin of the input filter of the field |
---|
347 | std::shared_ptr<CPassThroughFilter> inputFilter; |
---|
348 | |
---|
349 | //! The self temporal data filter |
---|
350 | std::shared_ptr<CTemporalFilter> selfTemporalDataFilter ; |
---|
351 | |
---|
352 | //! The output pin of the filter providing the instant data for the field |
---|
353 | std::shared_ptr<COutputPin> instantDataFilter; |
---|
354 | public: |
---|
355 | std::shared_ptr<COutputPin> getInstantDataFilter(void) { return instantDataFilter;} |
---|
356 | |
---|
357 | private: |
---|
358 | |
---|
359 | //! The output pin of the filters providing the result of the field's temporal operation |
---|
360 | std::map<CDuration, std::shared_ptr<COutputPin>, DurationFakeLessComparator> temporalDataFilters; |
---|
361 | |
---|
362 | //! The output pin of the filter providing the instant data for self references |
---|
363 | std::shared_ptr<COutputPin> selfReferenceFilter; // probably redondant with inputFilter |
---|
364 | |
---|
365 | //! The source filter for data provided by the client |
---|
366 | // std::shared_ptr<CSourceFilter> clientSourceFilter; // obsolete to remove |
---|
367 | |
---|
368 | //! The source filter for data provided by the model to enter the client workflow |
---|
369 | std::shared_ptr<CModelToClientSourceFilter> modelToClientSourceFilter_; |
---|
370 | |
---|
371 | //! The source filter for data provided by the model to enter the client workflow |
---|
372 | std::shared_ptr<CClientToModelStoreFilter> clientToModelStoreFilter_; |
---|
373 | |
---|
374 | //! The source filter for data provided by the client that send data to server workflow |
---|
375 | std::shared_ptr<CServerFromClientSourceFilter> serverFromClientSourceFilter_; |
---|
376 | |
---|
377 | //! The source filter for data provided by an other to enter the current client workflow (coupling mode) |
---|
378 | std::shared_ptr<CClientFromClientSourceFilter> clientFromClientSourceFilter_; |
---|
379 | |
---|
380 | //! The source filter for data provided by server to enter the current client workflow (reading mode) |
---|
381 | std::shared_ptr<CClientFromServerSourceFilter> clientFromServerSourceFilter_; |
---|
382 | |
---|
383 | //! The source filter for data read from file on server side |
---|
384 | std::shared_ptr<CFileReaderSourceFilter> fileReaderSourceFilter_; |
---|
385 | |
---|
386 | //! The source filter for data provided by the server |
---|
387 | // std::shared_ptr<CSourceFilter> serverSourceFilter; // obsolete to remove |
---|
388 | |
---|
389 | //! The terminal filter which send data to server for writing |
---|
390 | std::shared_ptr<CClientToServerStoreFilter> clientToServerStoreFilter_; |
---|
391 | |
---|
392 | //! The terminal filter which writes data to file |
---|
393 | std::shared_ptr<CFileWriterStoreFilter> fileWriterStoreFilter_; |
---|
394 | |
---|
395 | //! The terminal filter which send data from server to client |
---|
396 | std::shared_ptr<CServerToClientStoreFilter> serverToClientStoreFilter_; |
---|
397 | |
---|
398 | |
---|
399 | }; // class CField |
---|
400 | |
---|
401 | ///-------------------------------------------------------------- |
---|
402 | |
---|
403 | // Declare/Define CFieldGroup and CFieldDefinition |
---|
404 | DECLARE_GROUP(CField); |
---|
405 | |
---|
406 | ///----------------------------------------------------------------- |
---|
407 | |
---|
408 | template <> |
---|
409 | void CGroupTemplate<CField, CFieldGroup, CFieldAttributes>::solveRefInheritance(void); |
---|
410 | |
---|
411 | ///----------------------------------------------------------------- |
---|
412 | } // namespace xios |
---|
413 | |
---|
414 | |
---|
415 | #endif // __XIOS_CField__ |
---|