source: XIOS/dev/dev_olga/src/filter/store_filter.hpp @ 1654

#ifndef __XIOS_CStoreFilter__
#define __XIOS_CStoreFilter__

#include "input_pin.hpp"

namespace xios
{
  class CContext;
  class CGrid;

  /*!
   * A terminal filter which stores all the packets it receives.
   */
  class CStoreFilter : public CInputPin
  {
    public:
      /*!
       * Constructs the filter with one input slot and an associated
       * garbage collector for the specified grid and context.
       *
       * \param gc the garbage collector associated with this input pin
       * \param context the context to which the data belongs
       * \param grid the grid to which the data is attached
       * \param detectMissingValues whether missing values should be detected
       * \param missingValue the value to use to replace missing values
       */
      CStoreFilter(CGarbageCollector& gc, CContext* context, CGrid* grid,
                   bool detectMissingValues = false, double missingValue = 0.0);

      /*!
       * Accesses the filter storage and retuns the packet corresponding
       * to the specified timestamp. If there is no packet available for
       * the specified timestamp, the function waits until the data is
       * received or a timeout occurs.
       *
       * \param timestamp the timestamp of the requested packet
       * \return a pointer to a read-only packet
       */
      CConstDataPacketPtr getPacket(Time timestamp);

      /*!
       * Accesses the filter storage and retuns the data corresponding
       * to the specified timestamp. If there is no data available for
       * the specified timestamp, the function waits until the data is
       * received or a timeout occurs.
       *
       * \param timestamp the timestamp of the requested data
       * \param data the array where the data is to be copied
       * \return the status code associated with the data
       */
      template <int N>
      CDataPacket::StatusCode getData(Time timestamp, CArray<double, N>& data);

      /*!
       * Tests if the filter must auto-trigger.
       *
       * \return true if the filter must auto-trigger
       */
      bool virtual mustAutoTrigger() const;

      /*!
       * Tests whether data is expected for the specified date.
       *
       * \param date the date associated to the data
       */
      bool virtual isDataExpected(const CDate& date) const;

      /*!
       * Removes all pending packets which are older than the specified timestamp.
       *
       * \param timestamp the timestamp used for invalidation
       */
      void virtual invalidate(Time timestamp);

      /*!
       * Returns filter's id needed in case of building workflow graph
       */
      int getFilterId();

    protected:
      /*!
       * Stores the packet for later access.
       *
       * \param data a vector of packets corresponding to each slot
       */
      void virtual onInputReady(std::vector<CDataPacketPtr> data);

    private:
      CGarbageCollector& gc;            //!< The garbage collector associated to the filter
      CContext* context;                //!< The context to which the data belongs
      CGrid* grid;                      //!< The grid attached to the data the filter can accept
      const bool detectMissingValues;   //!< Whether missing values should be detected
      const double missingValue;        //!< The value to use to replace missing values
      std::map<Time, CDataPacketPtr> packets; //<! The stored packets
      int filterId;                     //!< Filter's id needed in case of building a workflow

  }; // class CStoreFilter
} // namespace xios

#endif //__XIOS_CStoreFilter__