source: XIOS/dev/dev_trunk_omp/src/filter/file_writer_filter.hpp @ 1668

#ifndef __XIOS_CFileWriterFilter__
#define __XIOS_CFileWriterFilter__

#include "input_pin.hpp"

namespace xios
{
  class CField;

  /*!
   * A terminal filter which transmits the packets it receives to a field for writting in a file.
   */
  class CFileWriterFilter : public CInputPin
  {
    public:
      /*!
       * Constructs the filter (with one input slot) associated to the specified field
       * and a garbage collector.
       *
       * \param gc the associated garbage collector
       * \param field the associated field
       * \param[in] buildWorkflowGraph indicates whether the workflow will be visualized
       */
      CFileWriterFilter(CGarbageCollector& gc, CField* field, bool buildWorkflowGraph = false);

      inline StdString GetName(void) {return StdString("File writer filter");};

      /*!
       * 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;

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

    protected:
      /*!
       * Callbacks a field to write a packet to a file.
       *
       * \param data a vector of packets corresponding to each slot
       */
      void virtual onInputReady(std::vector<CDataPacketPtr> data);

    private:
      CField* field; //<! The associated field
      std::map<Time, CDataPacketPtr> packets; //<! The stored packets
      int filterId;                           //<! Filter's id needed in case of building a workflow

  }; // class CFileWriterFilter
} // namespace xios

#endif //__XIOS_CFileWriterFilter__