source: trunk/src/Outputs/VOTableCatalogueWriter.hh @ 1069

// -----------------------------------------------------------------------
// VOTableCatalogueWriter.hh: Writing output catalogues to VOTable files
// -----------------------------------------------------------------------
// Copyright (C) 2006, Matthew Whiting, ATNF
//
// 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 2 of the License, or (at your
// option) any later version.
//
// Duchamp 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 Duchamp; if not, write to the Free Software Foundation,
// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
//
// Correspondence concerning Duchamp may be directed to:
//    Internet email: Matthew.Whiting [at] atnf.csiro.au
//    Postal address: Dr. Matthew Whiting
//                    Australia Telescope National Facility, CSIRO
//                    PO Box 76
//                    Epping NSW 1710
//                    AUSTRALIA
// -----------------------------------------------------------------------
#ifndef DUCHAMP_VOTABLE_CATALOGUE_WRITER_H_
#define DUCHAMP_VOTABLE_CATALOGUE_WRITER_H_

#include <duchamp/Outputs/CatalogueWriter.hh>
#include <duchamp/Detection/detection.hh>
#include <ios>
#include <iostream>
#include <fstream>
#include <string>

namespace duchamp {

  class VOTableCatalogueWriter : public CatalogueWriter
  {
  public:
    VOTableCatalogueWriter();
    VOTableCatalogueWriter(std::string name);
    VOTableCatalogueWriter(const VOTableCatalogueWriter& other);
    VOTableCatalogueWriter& operator= (const VOTableCatalogueWriter& other);
    virtual ~VOTableCatalogueWriter(){};

    /// @brief open the catalogue for writing
    bool openCatalogue(std::ios_base::openmode mode = std::ios_base::out);

    /// @brief Write header information - not including parameters
    void writeHeader();

    void writeParameters();
    void writeStats(); 
    void writeTableHeader();
    void writeEntries();
    void writeEntry(Detection *object);

    void writeFooter();

    bool closeCatalogue();

    void setTableName(std::string s){itsTableName=s;};
    void setTableDescription(std::string s){itsTableDescription=s;};

  protected:
    std::ofstream itsFileStream;
    std::string itsTableName;
    std::string itsTableDescription;
  };

}

#endif