JMonteCarloFileWriter.hh

Go to the documentation of this file.

#ifndef __JSUPPORT__JMONTECARLOFILEWRITER__
#define __JSUPPORT__JMONTECARLOFILEWRITER__

#include <ostream>

#include "JLang/JAccessibleStream.hh"
#include "JLang/JStreamObjectOutput.hh"
#include "JLang/JObjectOutput.hh"
#include "JLang/JTypeList.hh"
#include "JLang/JNullType.hh"


/**
 * \author mdejong
 */

namespace JSUPPORT {}
namespace JPP { using namespace JSUPPORT; }

namespace JSUPPORT {

  using JLANG::JAccessibleOutputStream;
  using JLANG::JObjectOutput;
  using JLANG::JNullOutput;
  using JLANG::JAccessibleObjectOutput;
  using JLANG::JTypeList;
  using JLANG::JNullType;
  

  /**
   * Template definition of Monte Carlo stream output for single data type.
   *
   * This class provides for a null implementation of the JLANG::JObjectOutput interface.
   * It should be specialised for the data types that will be written to a Monte Carlo file.
   */
  template<class T>
  class JMonteCarloStreamObjectOutput :
    public virtual JObjectOutput<T>,
    public virtual JNullOutput<T>
  {
  protected:
    /**
     * Constructor.
     *
     * \param  out        output stream
     */
    JMonteCarloStreamObjectOutput(std::ostream& out)
    {}
  };


  /**
   * Template specialisation of Monte Carlo stream object output for multiple data types.
   *
   * This class recursively implements the JLANG::JObjectOutput interface
   * for all data types by deriving from:
   *  - JMonteCarloStreamObjectOutput<JHead_t>; and 
   *  - JMonteCarloStreamObjectOutput<JTail_t>.
   */
  template<class JHead_t, class JTail_t>
  class JMonteCarloStreamObjectOutput< JTypeList<JHead_t, JTail_t> > :
    public virtual JObjectOutput< JTypeList<JHead_t, JTail_t> >,
    public JMonteCarloStreamObjectOutput<JHead_t>,
    public JMonteCarloStreamObjectOutput<JTail_t>

  {
  protected:
    /**
     * Constructor.
     *
     * \param  out        output stream
     */
    JMonteCarloStreamObjectOutput(std::ostream& out) :
      JMonteCarloStreamObjectOutput<JHead_t>(out),
      JMonteCarloStreamObjectOutput<JTail_t>(out)
    {}
  };


  /**
   * Terminator class of recursive JMonteCarloStreamObjectOutput class.
   */
  template<class JHead_t>
  class JMonteCarloStreamObjectOutput< JTypeList<JHead_t, JNullType> > :
    public JMonteCarloStreamObjectOutput<JHead_t>
  {
  protected:
    /**
     * Constructor.
     *
     * \param  out        output stream
     */
    JMonteCarloStreamObjectOutput(std::ostream& out) :
      JMonteCarloStreamObjectOutput<JHead_t>(out)
    {}
  };


  /**
   * Object(s) writing to Monte Carlo ASCII file (i.e.\ .evt)
   *
   * This class implements the JLANG::JAccessibleObjectOutput interface.
   */
  template<class T>
  class JMonteCarloFileWriter :
    public JAccessibleOutputStream,
    public JMonteCarloStreamObjectOutput<T>,
    public JAccessibleObjectOutput <T>
  {
  public:
    /**
     * Default constructor.
     */
    JMonteCarloFileWriter() :
      JAccessibleOutputStream(),
      JMonteCarloStreamObjectOutput<T>(static_cast<std::ostream&>(*this))
    {}
  };
}

#endif