source: XIOS/dev/dev_olga/src/filter/source_filter.hpp @ 1568

Last change on this file since 1568 was 1568, checked in by oabramkina, 3 years ago

Grid mask is now applied in the source filter of clients: unmasked values are replaced by NaN. It is not reconstructed any more by servers.

This needs to be tested more rigorously before commiting to trunk.

File size: 2.8 KB
Line 
1#ifndef __XIOS_CSourceFilter__
2#define __XIOS_CSourceFilter__
3
4#include <map>
5
6#include "output_pin.hpp"
7
8namespace xios
9{
10  class CGrid;
11
12  /*!
13   * A source filter is the entry point of the data in the graph of filters.
14   */
15  class CSourceFilter : public COutputPin
16  {
17    public:
18      /*!
19       * Constructs a source filter accepting data attached to the specified grid.
20       *
21       * \param gc the garbage collector associated with this filter
22       * \param grid the grid to which the data is attached
23       * \param compression
24       * \param mask
25       * \param offset the offset applied to the timestamp of all packets
26       * \param manualTrigger whether the output should be triggered manually
27       * \param hasMissingValue whether data has missing value
28       * \param defaultValue missing value to detect
29       */
30      CSourceFilter(CGarbageCollector& gc, CGrid* grid,
31                    bool compression = true,
32                    bool mask = false,
33                    const CDuration offset = NoneDu, bool manualTrigger = false,
34                    bool hasMissingValue = false,
35                    double defaultValue = 0.0);
36
37      /*!
38       * Transforms the data received from the model into a packet and send it
39       * in the filter graph. The array containing the data can safely be reused
40       * immediately after this method returns.
41       *
42       * \param date the date associated to the data
43       * \param data an array containing the data
44       */
45      template <int N>
46      void streamData(CDate date, const CArray<double, N>& data);
47
48      /*!
49       * Transforms the data received from the server into a packet and send it
50       * in the filter graph. The array containing the data can safely be reused
51       * immediately after this method returns.
52       *
53       * \param date the date associated to the data
54       * \param data an array containing the data
55       */
56      void streamDataFromServer(CDate date, const std::map<int, CArray<double, 1> >& data);
57
58      /*!
59       * Signals the filter graph that the end of stream was reached.
60       *
61       * \param date the date at which the end of stream occurred
62       */
63      void signalEndOfStream(CDate date);
64
65    private:
66      CGrid* grid;             //!< The grid attached to the data the filter can accept
67      const CDuration offset;  //!< The offset applied to the timestamp of all packets
68      const bool hasMissingValue;
69      const double defaultValue;
70      const bool compression ; //!< indicates if data need to be compressed : on client side : true, on server side : false
71      const bool mask ;        //!< indicates whether grid mask should be applied (true for clients, false for servers)
72  }; // class CSourceFilter
73} // namespace xios
74
75#endif //__XIOS_CSourceFilter__
Note: See TracBrowser for help on using the repository browser.