src/ADataOutput.h

   1 //! \file ADataOutput.h
   2
   3 #ifndef _ADATAOUTPUT_H
   4 #define _ADATAOUTPUT_H
   5
   6 #include <ostream>
   7 #include "ArticleCollection.h"
   8
   9 /*! Abstract base class for output modules.
  10  * Child classes are responsible for converting the article structure
  11  * to other formats.
  12  */
  13 class ADataOutput
  14 {
  15 public:
  16     /*! Output an article to an outstream.
  17      * \param a pointer to article to be output
  18      * \param os out stream to putput to.
  19      * YOU are responsible for opening and closing the stream
  20      */
  21     virtual void output(const Article* a, std::ostream& os) = 0;
  22
  23     /*! Output an article collection to an outstream.
  24      * \param ac reference to article collection to be output
  25      * \param os out stream to putput to
  26      * YOU are responsible for opening and closing the stream
  27      */
  28     virtual void output(const ArticleCollection& ac, std::ostream& os) = 0;
  29
  30     virtual ~ADataOutput() {}
  31 };
  32
  33 #endif // _ADATAOUTPUT_H