source: trunk/yat/omic/BamWriteIterator.h @ 2910

#ifndef theplu_yat_omic_bam_write_iterator
#define theplu_yat_omic_bam_write_iterator

// $Id: BamWriteIterator.h 2910 2012-12-17 02:31:13Z peter $
//
// Copyright (C) 2012 Peter Johansson
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.

#include <boost/function_output_iterator.hpp>

#include <functional>

namespace theplu {
namespace yat {
namespace omic {

  class BamRead;
  class OutBamFile;

  /**
     Functor taking a BamRead and writing to an OutBamFile. Class is
     primarily used by BamWriteIterator.

     \since New in yat 0.10
   */
  class BamWriter : std::unary_function<const BamRead&, void>
  {
  public:
    /**
       \brief Default constructor

       \note Created object cannot write, i.e., behaviour of
       operator() is undefined.
    */
    BamWriter(void);

    /**
       \brief Constructor

       Creates an object that will write to \a out.
     */
    explicit BamWriter(OutBamFile& out);

    /**
       write bam read \b to OutBamFile specified in constructor.
     */
    void operator()(const BamRead& b) const;
  private:
    OutBamFile* out_;
  };


  /**
     \brief Output iterator for bam file.

     A BamWriteIterator is an \output_iterator that writes output to a
     specific OutBamFile. The writing is performed via
     \code
     *iter = bam;
     \endcode
     where operator* retunrns a proxy which when assigned writes the
     right hand side to associated OutBamFile.

     \see OutBamFile and
     <a href="http://www.sgi.com/tech/stl/ostream_iterator.html">
     std::ostream_iterator</a>

     \since New in yat 0.10
   */
  class BamWriteIterator
    : public boost::function_output_iterator<BamWriter>
  {
  public:
    /**
       \brief Default contructor

       result is not dereferencable
     */
    BamWriteIterator(void);

    /**
       Creates an iterator that is associated with \a out.
     */
    explicit BamWriteIterator(OutBamFile& out);
  private:
  };
}}}
#endif