source: XIOS/dev/XIOS_DEV_CMIP6/src/filter/file_writer_filter.hpp @ 1358

Last change on this file since 1358 was 1358, checked in by rlacroix, 4 years ago

Support reentrant workflows and workflows with temporal integration for fields read from files.

File size: 1.4 KB
Line 
1#ifndef __XIOS_CFileWriterFilter__
2#define __XIOS_CFileWriterFilter__
3
4#include "input_pin.hpp"
5
6namespace xios
7{
8  class CField;
9
10  /*!
11   * A terminal filter which transmits the packets it receives to a field for writting in a file.
12   */
13  class CFileWriterFilter : public CInputPin
14  {
15    public:
16      /*!
17       * Constructs the filter (with one input slot) associated to the specified field
18       * and a garbage collector.
19       *
20       * \param gc the associated garbage collector
21       * \param field the associated field
22       */
23      CFileWriterFilter(CGarbageCollector& gc, CField* field);
24
25      /*!
26       * Tests if the filter must auto-trigger.
27       *
28       * \return true if the filter must auto-trigger
29       */
30      bool virtual mustAutoTrigger() const;
31
32      /*!
33       * Tests whether data is expected for the specified date.
34       *
35       * \param date the date associated to the data
36       */
37      bool virtual isDataExpected(const CDate& date) const;
38
39    protected:
40      /*!
41       * Callbacks a field to write a packet to a file.
42       *
43       * \param data a vector of packets corresponding to each slot
44       */
45      void virtual onInputReady(std::vector<CDataPacketPtr> data);
46
47    private:
48      CField* field; //<! The associated field
49      std::map<Time, CDataPacketPtr> packets; //<! The stored packets
50  }; // class CFileWriterFilter
51} // namespace xios
52
53#endif //__XIOS_CFileWriterFilter__
Note: See TracBrowser for help on using the repository browser.