source: trunk/src/Cubes/VOTable.hh @ 912

// -----------------------------------------------------------------------
// VOTable.hh: Output of the detected objects to a VOTable
// -----------------------------------------------------------------------
// 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 VOTABLE_HH
#define VOTABLE_HH

#include <iostream>
#include <sstream>
#include <fstream>
#include <iomanip>
#include <string>
#include <vector>
#include <time.h>
#include <duchamp/param.hh>
#include <duchamp/fitsHeader.hh>
#include <duchamp/Cubes/cubes.hh> 
#include <duchamp/Detection/detection.hh>
#include <duchamp/Detection/columns.hh>
 

namespace duchamp
{

  ///  @brief A class that holds information for a <FIELD > entry in a
  ///  VOTable. 
  ///  @details It also provides useful functions to store and print
  ///  that information.

  class VOField
  {
  public:
    /// @brief Define a FIELD by individual parameters 
    void define(std::string i, std::string n, std::string U, std::string u, std::string d, std::string r, int w, int p);
    /// @brief Define a FIELD by individual parameters, using a Column::Col object 
    void define(Column::Col column, std::string i, std::string U, std::string d, std::string r);
    /// @brief Define a FIELD for a particular Column::Col object 
    void define(Column::Col);

    void setUCD(std::string u){UCD=u;};

    /// @brief Print the FIELD entry 
    void printField(std::ostream &stream);
    
  private:
    std::string ID;
    std::string name;
    std::string UCD;
    std::string unit;
    std::string datatype;
    std::string ref;
    int width;
    int precision;

  };

  // ///  @brief A class that holds information for a <PARAM > entry in a
  // ///  VOTable. @details It also provides useful functions to store
  // ///  and print that information.
  // class VOParam
  // {
  // public:
  //   /// @brief Define a PARAM by individual parameters 
  //   template <class T> void define(std::string n, std::string U, std::string d, T v, int w, std::string u);
 
  //   /// @brief Print the PARAM entry 
  //   void printParam(std::ostream &stream);
    
  // private:
  //   std::string name;
  //   std::string UCD;
  //   std::string datatype;
  //   std::string value;
  //   int width;
  //   std::string units;
    
  // };

}

#endif //VOTABLE_HH