source: trunk/src/Outputs/CatalogueSpecification.hh @ 1441

// -----------------------------------------------------------------------
// CatalogueSpecification.hh: Define the specification of a catalogue,
//                            being a set of Columns
// -----------------------------------------------------------------------
// 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_CATALOGUE_SPEC_H
#define DUCHAMP_CATALOGUE_SPEC_H

#include <duchamp/duchamp.hh>
#include <duchamp/Outputs/columns.hh>
#include <vector>
#include <map>

namespace duchamp {

    class Detection;
    class FitsHeader;

  namespace Catalogues {

    class CatalogueSpecification 
    {
    public:
      CatalogueSpecification(){};
      CatalogueSpecification(const CatalogueSpecification& other);
      CatalogueSpecification& operator= (const CatalogueSpecification& other);
      virtual ~CatalogueSpecification(){};

      void addColumn(Column col);
      void addColumn(std::string type, std::string name, std::string units, int width, int prec, std::string ucd="", std::string datatype="", std::string colID="", std::string extraInfo="");
      Column &column(std::string type){return itsColumnList[itsTypeMap[type]];};
      Column &column(int i){return itsColumnList[i];};
      Column *pCol(int i){return &(itsColumnList[i]);};
      void removeColumn(std::string type);
      bool hasColumn(std::string type);
      void setMap();
      size_t size(){return itsColumnList.size();};
      
      void outputTableHeader(std::ostream &stream, Catalogues::DESTINATION tableType, bool flagWCS);

      /// @brief Set the comment characters
      void setCommentString(std::string comment){itsCommentString = comment;};
      std::string commentString(){return itsCommentString;};

        /// If the named column exists in the specification, check its width using the value
        template <class T> void check(std::string type, T value);
        /// If the named column exists in the specification, check its width and precision using the value
        template <class T> void check(std::string type, T value, bool doPrec);

        void checkAll(std::vector<Detection> &objectList, FitsHeader &head);

    protected:
      std::vector<Column> itsColumnList;
      std::map<std::string, int> itsTypeMap;
      std::string itsCommentString; ///< Any comment characters etc that need to be prepended to the table header

    };


    /// @brief Returns a vector of Col for results file output.
    CatalogueSpecification getFullColSet(std::vector<Detection> &objectList, FitsHeader &head);
    
    /// @brief Returns a vector of Col for logfile output.
    CatalogueSpecification getLogColSet(std::vector<Detection> &objectList, FitsHeader &head);

  }

}
#endif