source: XIOS/trunk/src/node/field.hpp @ 707

Last change on this file since 707 was 707, checked in by rlacroix, 9 years ago

Append mode: Detect the correct restart point and erase some records if need be.

  • 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: 7.8 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
19
20namespace xios {
21
22   /// ////////////////////// Déclarations ////////////////////// ///
23
24   class CFieldGroup;
25   class CFieldAttributes;
26   class CField;
27
28   class CFile;
29   class CGrid;
30   class CContext;
31   class CGenericFilter;
32
33   class CGarbageCollector;
34   class COutputPin;
35   class CSourceFilter;
36   class CStoreFilter;
37   class CFileWriterFilter;
38
39   ///--------------------------------------------------------------
40
41   // Declare/Define CFieldAttribute
42   BEGIN_DECLARE_ATTRIBUTE_MAP(CField)
43#  include "field_attribute.conf"
44   END_DECLARE_ATTRIBUTE_MAP(CField)
45
46   ///--------------------------------------------------------------
47   class CField
48      : public CObjectTemplate<CField>
49      , public CFieldAttributes
50   {
51         /// friend ///
52         friend class CFile;
53
54         /// typedef ///
55         typedef CObjectTemplate<CField>   SuperClass;
56         typedef CFieldAttributes SuperClassAttribute;
57
58      public:
59
60         typedef CFieldAttributes RelAttributes;
61         typedef CFieldGroup      RelGroup;
62
63         enum EEventId
64         {
65           EVENT_ID_UPDATE_DATA, EVENT_ID_READ_DATA, EVENT_ID_READ_DATA_READY,
66           EVENT_ID_ADD_VARIABLE, EVENT_ID_ADD_VARIABLE_GROUP
67         };
68
69         /// Constructeurs ///
70         CField(void);
71         explicit CField(const StdString& id);
72         CField(const CField& field);       // Not implemented yet.
73         CField(const CField* const field); // Not implemented yet.
74
75         /// Accesseurs ///
76
77         CGrid* getRelGrid(void) const;
78         CFile* getRelFile(void) const;
79
80         func::CFunctor::ETimeType getOperationTimeType() const;
81
82      public:
83         StdSize getNStep(void) const;
84
85         template <int N> void getData(CArray<double, N>& _data) const;
86
87         boost::shared_ptr<COutputPin> getInstantDataFilter();
88
89         /// Mutateur ///
90         void setRelFile(CFile* _file);
91         void incrementNStep(void);
92         void resetNStep(StdSize nstep = 0);
93         void resetNStepMax();
94
95         std::map<int, StdSize> getGridDataSize();
96
97       public:
98         bool isActive(void) const;
99         bool hasOutputFile;
100
101         bool wasWritten() const;
102         void setWritten();
103
104         bool getUseCompressedOutput() const;
105         void setUseCompressedOutput();
106
107         /// Traitements ///
108         void solveGridReference(void);
109         void solveServerOperation(void);
110         void solveCheckMaskIndex(bool doSendingIndex);
111         void solveAllReferenceEnabledField(bool doSending2Sever);
112         void solveGridDomainAxisRef(bool checkAtt);
113         void solveTransformedGrid();
114         void solveGenerateGrid();
115
116         void buildFilterGraph(CGarbageCollector& gc, bool enableOutput);
117         boost::shared_ptr<COutputPin> getSelfReference(CGarbageCollector& gc);
118         boost::shared_ptr<COutputPin> getTemporalDataFilter(CGarbageCollector& gc, CDuration outFreq);
119
120//         virtual void fromBinary(StdIStream& is);
121
122         /// Destructeur ///
123         virtual ~CField(void);
124
125         /// Accesseurs statiques ///
126         static StdString GetName(void);
127         static StdString GetDefName(void);
128
129         static ENodeType GetType(void);
130
131        template <int N> void setData(const CArray<double, N>& _data);
132        static bool dispatchEvent(CEventServer& event);
133        void sendUpdateData(const CArray<double,1>& data);
134        static void recvUpdateData(CEventServer& event);
135        void recvUpdateData(vector<int>& ranks, vector<CBufferIn*>& buffers);
136        void writeField(void);
137        void sendReadDataRequest(void);
138        bool sendReadDataRequestIfNeeded(void);
139        static void recvReadDataRequest(CEventServer& event);
140        void recvReadDataRequest(void);
141        bool readField(void);
142        static void recvReadDataReady(CEventServer& event);
143        void recvReadDataReady(vector<int> ranks, vector<CBufferIn*> buffers);
144        void outputField(CArray<double,3>& fieldOut);
145        void outputField(CArray<double,2>& fieldOut);
146        void outputField(CArray<double,1>& fieldOut);
147        void inputField(CArray<double,3>& fieldOut);
148        void inputField(CArray<double,2>& fieldOut);
149        void inputField(CArray<double,1>& fieldOut);
150        void outputCompressedField(CArray<double, 1>& fieldOut);
151        void scaleFactorAddOffset(double scaleFactor, double addOffset);
152        void invertScaleFactorAddOffset(double scaleFactor, double addOffset);
153        void parse(xml::CXMLNode& node);
154
155        void setVirtualVariableGroup(CVariableGroup* newVVariableGroup);
156        void setVirtualVariableGroup(void);
157        CVariableGroup* getVirtualVariableGroup(void) const;
158        vector<CVariable*> getAllVariables(void) const;
159        virtual void solveDescInheritance(bool apply, const CAttributeMap* const parent = 0);
160
161        CVariable* addVariable(const string& id = "");
162        CVariableGroup* addVariableGroup(const string& id = "");
163        void sendAddVariable(const string& id = "");
164        void sendAddVariableGroup(const string& id = "");
165        static void recvAddVariable(CEventServer& event);
166        void recvAddVariable(CBufferIn& buffer);
167        static void recvAddVariableGroup(CEventServer& event);
168        void recvAddVariableGroup(CBufferIn& buffer);
169        void sendAddAllVariables();
170
171
172        const std::pair<StdString, StdString>& getRefDomainAxisIds();
173
174      public:
175         /// Propriétés privées ///
176         CVariableGroup* vVariableGroup;
177
178         CGrid*  grid;
179         CFile*  file;
180
181         CDuration freq_operation_srv, freq_write_srv;
182
183         bool written; //<! Was the field written at least once
184         StdSize nstep, nstepMax;
185         bool isEOF;
186         CDate lastlast_Write_srv, last_Write_srv, last_operation_srv;
187         CDate lastDataRequestedFromServer;
188
189         map<int,boost::shared_ptr<func::CFunctor> > foperation_srv;
190
191         map<int, CArray<double,1> > data_srv;
192         string content;
193
194         bool areAllReferenceSolved;
195         std::pair<StdString,StdString> domAxisIds_;
196         bool isReadDataRequestPending;
197         bool useCompressedOutput;
198
199         DECLARE_REF_FUNC(Field,field)
200
201      private:
202         //! The type of operation attached to the field
203         func::CFunctor::ETimeType operationTimeType;
204
205         //! The output pin of the filter providing the instant data for the field
206         boost::shared_ptr<COutputPin> instantDataFilter;
207         //! The output pin of the filters providing the result of the field's temporal operation
208         std::map<CDuration, boost::shared_ptr<COutputPin>, DurationFakeLessComparator> temporalDataFilters;
209         //! The source filter for data provided by the client
210         boost::shared_ptr<CSourceFilter> clientSourceFilter;
211         //! The source filter for data provided by the server
212         boost::shared_ptr<CSourceFilter> serverSourceFilter;
213         //! The terminal filter which stores the instant data
214         boost::shared_ptr<CStoreFilter> storeFilter;
215         //! The terminal filter which writes the data to file
216         boost::shared_ptr<CFileWriterFilter> fileWriterFilter;
217   }; // class CField
218
219   ///--------------------------------------------------------------
220
221   // Declare/Define CFieldGroup and CFieldDefinition
222   DECLARE_GROUP(CField);
223
224   ///-----------------------------------------------------------------
225
226   template <>
227      void CGroupTemplate<CField, CFieldGroup, CFieldAttributes>::solveRefInheritance(void);
228
229   ///-----------------------------------------------------------------
230} // namespace xios
231
232
233#endif // __XIOS_CField__
Note: See TracBrowser for help on using the repository browser.