source: XIOS/dev/branch_yushan_merged/src/filter/temporal_filter.hpp @ 1205

Last change on this file since 1205 was 1205, checked in by yushan, 3 years ago

branch merged with trunk @1200

File size: 3.1 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       * \param missingValue the missing value
29       */
30      CTemporalFilter(CGarbageCollector& gc, const std::string& opId,
31                      const CDate& initDate, const CDuration samplingFreq, const CDuration samplingOffset, const CDuration opFreq,
32                      bool ignoreMissingValue = false, double missingValue = 0.0);
33
34      /*!
35       * Applies the temporal operation to the input data and returns the result when it is ready.
36       *
37       * \param data a vector of packets corresponding to each slot (one in this case)
38       * \return the result of the temporal operation or null if it is not ready yet
39       */
40      CDataPacketPtr virtual apply(std::vector<CDataPacketPtr> data);
41
42      /*!
43       * Tests whether data is expected for the specified date.
44       *
45       * \param date the date associated to the data
46       */
47      bool virtual isDataExpected(const CDate& date) const;
48
49    private:
50      // Warning the declaration order matters here, double-check the constructor before changing it
51      CArray<double, 1> tmpData; //!< The array of data used for temporary storage
52      const boost::scoped_ptr<func::CFunctor> functor; //!< The functor corresponding to the temporal operation
53      const bool isOnceOperation; //!< True if the operation should be computed just once
54      const bool isInstantOperation; //!< True if the operation is instant
55      const CDuration samplingFreq; //!< The sampling frequency, i.e. the frequency at which the input data will be used
56      const CDuration samplingOffset; //!< The sampling offset, i.e. the offset after which the input data will be used
57      const CDuration opFreq; //!< The operation frequency, i.e. the frequency at which the output data will be computed
58      CDate nextSamplingDate; //!< The date of the next sampling
59      CDate nextOperationDate; //!< The date of the next operation
60      bool isFirstOperation; //!< True before the first operation was been computed
61  }; // class CTemporalFilter
62} // namespace xios
63
64#endif //__XIOS_CTemporalFilter__
Note: See TracBrowser for help on using the repository browser.