source: tags/release-1.2.2/src/Utils/VOParam.cc

Last change on this file was 1075, checked in by MatthewWhiting, 12 years ago

Improved parameter output for the annotation files. Tidying up the VOParam & VOField classes, and adding some documentation comments.

File size: 3.9 KB
Line 
1// -----------------------------------------------------------------------
2// VOParam.cc: Output of the detected objects to a VOTable
3// -----------------------------------------------------------------------
4// Copyright (C) 2006, Matthew Whiting, ATNF
5//
6// This program is free software; you can redistribute it and/or modify it
7// under the terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 2 of the License, or (at your
9// option) any later version.
10//
11// Duchamp is distributed in the hope that it will be useful, but WITHOUT
12// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13// FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14// for more details.
15//
16// You should have received a copy of the GNU General Public License
17// along with Duchamp; if not, write to the Free Software Foundation,
18// Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
19//
20// Correspondence concerning Duchamp may be directed to:
21//    Internet email: Matthew.Whiting [at] atnf.csiro.au
22//    Postal address: Dr. Matthew Whiting
23//                    Australia Telescope National Facility, CSIRO
24//                    PO Box 76
25//                    Epping NSW 1710
26//                    AUSTRALIA
27// -----------------------------------------------------------------------
28
29#include <iostream>
30#include <sstream>
31#include <duchamp/Utils/VOParam.hh>
32
33namespace duchamp {
34
35  VOParam::VOParam()
36  {
37  }
38 
39  template <class T> VOParam::VOParam(std::string name, std::string UCD, std::string datatype, T value, int width, std::string units):
40    itsName(name),itsUCD(UCD),itsDatatype(datatype),itsWidth(width),itsUnits(units)
41  {
42    /// @details
43    /// A basic definition function, defining each parameter
44    /// individually. The value (v) is written to a stringstream, and
45    /// from there stored as a string.
46    /// \param name The name
47    /// \param UCD The UCD
48    /// \param datatype The datatype
49    /// \param value The value
50    /// \param width The width
51    /// \param units The units
52
53    std::stringstream ss;
54    ss << value;
55    this->itsValue = ss.str();
56  }
57  template VOParam::VOParam(std::string n, std::string U, std::string d, bool v, int w, std::string u);
58  template VOParam::VOParam(std::string n, std::string U, std::string d, int v, int w, std::string u);
59  template VOParam::VOParam(std::string n, std::string U, std::string d, unsigned int v, int w, std::string u);
60  template VOParam::VOParam(std::string n, std::string U, std::string d, long v, int w, std::string u);
61  template VOParam::VOParam(std::string n, std::string U, std::string d, float v, int w, std::string u);
62  template VOParam::VOParam(std::string n, std::string U, std::string d, double v, int w, std::string u);
63  template VOParam::VOParam(std::string n, std::string U, std::string d, std::string v, int w, std::string u);
64
65  VOParam::VOParam(const VOParam& other)
66  {
67    operator=(other);
68  }
69
70  VOParam& VOParam::operator= (const VOParam& other)
71  {
72    if(this==&other) return *this;
73    this->itsName = other.itsName;
74    this->itsUCD = other.itsUCD;
75    this->itsDatatype=other.itsDatatype;
76    this->itsWidth = other.itsWidth;
77    this->itsValue = other.itsValue;
78    this->itsUnits = other.itsUnits;
79    return *this;
80  }
81 
82
83  void VOParam::printParam(std::ostream &stream)
84  {
85    /// @details
86    /// Print the Param entry with appropriate formatting.
87    /// \param stream The output stream to send the text to.
88
89    stream << "<PARAM name=\"" <<this->itsName
90           << "\" ucd=\"" << this->itsUCD
91           << "\" datatype=\"" << this->itsDatatype;
92    if(this->itsUnits!="")
93      stream << "\" units=\"" << this->itsUnits;
94    if(this->itsWidth!=0){
95      if(this->itsDatatype=="char")
96        stream << "\" arraysize=\"" << this->itsWidth;
97      else
98        stream << "\" width=\"" << this->itsWidth;
99    }
100    stream << "\" value=\"" << this->itsValue
101           << "\"/>\n";
102  }
103
104  //------------------------------------------------
105
106
107
108}
Note: See TracBrowser for help on using the repository browser.