GFitsHeaderCard.hpp
7.11 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
/***************************************************************************
* GFitsHeaderCard.hpp - FITS header card class *
* ----------------------------------------------------------------------- *
* copyright (C) 2008-2013 by Juergen Knoedlseder *
* ----------------------------------------------------------------------- *
* *
* 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/>. *
* *
***************************************************************************/
/**
* @file GFitsHeaderCard.hpp
* @brief FITS header card class definition
* @author Juergen Knoedlseder
*/
#ifndef GFITSHEADERCARD_HPP
#define GFITSHEADERCARD_HPP
/* __ Includes ___________________________________________________________ */
#include <string>
#include "GBase.hpp"
/***********************************************************************//**
* @class GFitsHeaderCard
*
* @brief Implements FITS header card interface
*
* This class implements a FITS header card. A header card consists of a
* keyname (string), a value (string, floating point, integer or logical)
* and a comment (string). COMMENT or HISTORY cards do not have a value.
*
* @todo Many more datatypes may exist for a header card.
***************************************************************************/
class GFitsHeaderCard : public GBase {
// Friend classes
friend class GFitsHeader;
public:
// Constructors & Destructors
GFitsHeaderCard(void);
GFitsHeaderCard(const std::string& keyname, const std::string& value,
const std::string& comment);
GFitsHeaderCard(const std::string& keyname, const double& value,
const std::string& comment);
GFitsHeaderCard(const std::string& keyname, const int& value,
const std::string& comment);
GFitsHeaderCard(const GFitsHeaderCard& card);
virtual ~GFitsHeaderCard(void);
// Operators
GFitsHeaderCard& operator=(const GFitsHeaderCard& card);
// Methods
void clear(void);
GFitsHeaderCard* clone(void) const;
void keyname(const std::string& keyname);
std::string keyname(void) const;
void value(const std::string& value);
void value(const bool& value);
void value(const float& value);
void value(const double& value);
void value(const unsigned short& value);
void value(const short& value);
void value(const unsigned int& value);
void value(const int& value);
void value(const long& value);
void value(const unsigned long& value);
void value(const long long& value);
std::string value(void) const;
int decimals(void) const;
void unit(const std::string& unit);
std::string unit(void) const;
void comment(const std::string& comment);
std::string comment(void) const;
std::string string(void) const;
double real(void) const;
int integer(void) const;
std::string print(const GChatter& chatter = NORMAL) const;
private:
// Private methods
void init_members(void);
void copy_members(const GFitsHeaderCard& card);
void free_members(void);
void copy_dtype(const GFitsHeaderCard& card);
void free_dtype(void);
void set_dtype(const std::string& value);
void read(void* vptr, const int& keynum);
void read(void* fptr, const std::string& keyname);
void write(void* fptr) const;
// Private data area
std::string m_keyname; //!< Name of the card
std::string m_value; //!< Value of the card as read from file
void* m_value_dtype; //!< Value in native data type
int m_dtype; //!< Native data type
int m_value_decimals; //!< Decimals of value (for float)
std::string m_unit; //!< Unit of the card value
std::string m_comment; //!< Card comment
bool m_comment_write; //!< Signals that comment should be written
};
/***********************************************************************//**
* @brief Set unit of header card value
*
* @param[in] unit Unit of header card.
***************************************************************************/
inline
void GFitsHeaderCard::unit(const std::string& unit)
{
m_unit = unit;
return;
}
/***********************************************************************//**
* @brief Set comment of header card
*
* @param[in] comment Header card comment.
***************************************************************************/
inline
void GFitsHeaderCard::comment(const std::string& comment)
{
m_comment = comment;
return;
}
/***********************************************************************//**
* @brief Return header card keyname
***************************************************************************/
inline
std::string GFitsHeaderCard::keyname(void) const
{
return m_keyname;
}
/***********************************************************************//**
* @brief Return header card value
***************************************************************************/
inline
std::string GFitsHeaderCard::value(void) const
{
return m_value;
}
/***********************************************************************//**
* @brief Return header card decimals
***************************************************************************/
inline
int GFitsHeaderCard::decimals(void) const
{
return m_value_decimals;
}
/***********************************************************************//**
* @brief Return header card value unit
***************************************************************************/
inline
std::string GFitsHeaderCard::unit(void) const
{
return m_unit;
}
/***********************************************************************//**
* @brief Return header card comment
***************************************************************************/
inline
std::string GFitsHeaderCard::comment(void) const
{
return m_comment;
}
#endif /* GFITSHEADERCARD_HPP */