[643] | 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 | |
---|
| 9 | namespace 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 | |
---|
[1158] | 42 | /*! |
---|
[1358] | 43 | * Tests if the filter must auto-trigger. |
---|
| 44 | * |
---|
| 45 | * \return true if the filter must auto-trigger |
---|
| 46 | */ |
---|
| 47 | bool virtual mustAutoTrigger() const; |
---|
| 48 | |
---|
| 49 | /*! |
---|
[1158] | 50 | * Tests whether data is expected for the specified date. |
---|
| 51 | * |
---|
| 52 | * \param date the date associated to the data |
---|
| 53 | */ |
---|
| 54 | bool virtual isDataExpected(const CDate& date) const; |
---|
| 55 | |
---|
[643] | 56 | private: |
---|
[1201] | 57 | // Warning the declaration order matters here, double-check the constructor before changing it |
---|
| 58 | CArray<double, 1> tmpData; //!< The array of data used for temporary storage |
---|
[1158] | 59 | const boost::scoped_ptr<func::CFunctor> functor; //!< The functor corresponding to the temporal operation |
---|
[1201] | 60 | const bool isOnceOperation; //!< True if the operation should be computed just once |
---|
| 61 | const bool isInstantOperation; //!< True if the operation is instant |
---|
[643] | 62 | const CDuration samplingFreq; //!< The sampling frequency, i.e. the frequency at which the input data will be used |
---|
[1158] | 63 | const CDuration samplingOffset; //!< The sampling offset, i.e. the offset after which the input data will be used |
---|
[643] | 64 | const CDuration opFreq; //!< The operation frequency, i.e. the frequency at which the output data will be computed |
---|
[1302] | 65 | const CDuration offsetMonth; //!< The month duration of samplingOffset |
---|
| 66 | CDuration offsetAllButMonth; //!< All but the month duration of samplingOffset |
---|
| 67 | const CDate initDate; |
---|
[643] | 68 | CDate nextSamplingDate; //!< The date of the next sampling |
---|
[1302] | 69 | int nbOperationDates; //!< The number of times an operation is performed |
---|
| 70 | // CDate nextOperationDate; //!< The date of the next operation |
---|
[1285] | 71 | bool isFirstOperation; //!< True before the first operation was been computed |
---|
[643] | 72 | }; // class CTemporalFilter |
---|
| 73 | } // namespace xios |
---|
| 74 | |
---|
| 75 | #endif //__XIOS_CTemporalFilter__ |
---|