source: XIOS/dev/XIOS_DEV_CMIP6/src/filter/temporal_filter.hpp @ 1440

Last change on this file since 1440 was 1440, checked in by ymipsl, 3 years ago

Bug fix : for temporal filter, to detect_missing value, default_value attribute must be defined in the incoming field. This is not requiere any more since default value is automatically fixed to NaN in the internal workflow.

YM

File size: 3.5 KB
Line 
1#ifndef __XIOS_CTemporalFilter__
2#define __XIOS_CTemporalFilter__
3
4#include "filter.hpp"
5#include <boost/smart_ptr/scoped_ptr.hpp>
6#include "functor.hpp"
7#include "array_new.hpp"
8
9namespace xios
10{
11  /*!
12   * A generic temporal filter with one input slot wrapping any type of temporal operation.
13   */
14  class CTemporalFilter : public CFilter, public IFilterEngine
15  {
16    public:
17      /*!
18       * Constructs a temporal filter wrapping the specified temporal operation.
19       *
20       * \param gc the associated garbage collector
21       * \param opId the string identifying the temporal operation
22       * \param initDate the origin of time
23       * \param samplingFreq the sampling frequency, i.e. the frequency at which the input data will be used
24       * \param samplingOffset the sampling offset, i.e. the offset after which the input data will be used
25       * \param opFreq the operation frequency, i.e. the frequency at which the output data will be computed
26       * \param ignoreMissingValue true if and only if the missing value must be ignored
27                                   when doing the operation
28       */
29      CTemporalFilter(CGarbageCollector& gc, const std::string& opId,
30                      const CDate& initDate, const CDuration samplingFreq, const CDuration samplingOffset, const CDuration opFreq,
31                      bool ignoreMissingValue = false);
32
33      /*!
34       * Applies the temporal operation to the input data and returns the result when it is ready.
35       *
36       * \param data a vector of packets corresponding to each slot (one in this case)
37       * \return the result of the temporal operation or null if it is not ready yet
38       */
39      CDataPacketPtr virtual apply(std::vector<CDataPacketPtr> data);
40
41      /*!
42       * Tests if the filter must auto-trigger.
43       *
44       * \return true if the filter must auto-trigger
45       */
46      bool virtual mustAutoTrigger() const;
47
48      /*!
49       * Tests whether data is expected for the specified date.
50       *
51       * \param date the date associated to the data
52       */
53      bool virtual isDataExpected(const CDate& date) const;
54
55    private:
56      // Warning the declaration order matters here, double-check the constructor before changing it
57      CArray<double, 1> tmpData; //!< The array of data used for temporary storage
58      const boost::scoped_ptr<func::CFunctor> functor; //!< The functor corresponding to the temporal operation
59      const bool isOnceOperation; //!< True if the operation should be computed just once
60      const bool isInstantOperation; //!< True if the operation is instant
61      const CDuration samplingFreq; //!< The sampling frequency, i.e. the frequency at which the input data will be used
62      const CDuration samplingOffset; //!< The sampling offset, i.e. the offset after which the input data will be used
63      const CDuration opFreq; //!< The operation frequency, i.e. the frequency at which the output data will be computed
64      const CDuration offsetMonth; //!< The month duration of samplingOffset
65      CDuration offsetAllButMonth; //!< All but the month duration of samplingOffset
66      const CDate initDate;
67      CDate nextSamplingDate; //!< The date of the next sampling
68      int nbOperationDates; //!< The number of times an operation is performed
69//      CDate nextOperationDate; //!< The date of the next operation
70      bool isFirstOperation; //!< True before the first operation was been computed
71  }; // class CTemporalFilter
72} // namespace xios
73
74#endif //__XIOS_CTemporalFilter__
Note: See TracBrowser for help on using the repository browser.