GCsv.hpp
6.84 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
/***************************************************************************
* GCsv.hpp - Comma-separated values table class *
* ----------------------------------------------------------------------- *
* copyright (C) 2010-2016 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 GCsv.hpp
* @brief Comma-separated values table class definition
* @author Juergen Knoedlseder
*/
#ifndef GCSV_HPP
#define GCSV_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GBase.hpp"
/* __ Forward declarations _______________________________________________ */
class GFilename;
/***********************************************************************//**
* @class GCsv
*
* @brief Comma-separated values table class
*
* This class implements a table of std::string elements that is loaded
* from a comma-separated value ASCII file. The comma-separation string
* can be specified upon loading of the file (by default the class assumes
* that elements are separated by a white space).
*
* The class provides operators for string element access, and methods for
* conversion of the string values:
*
* double real = csv.real(row,col);
* int integer = csv.integer(row,col);
* std::string string = csv.string(row,col);
*
***************************************************************************/
class GCsv : public GBase {
public:
// Constructors and destructors
GCsv(void);
GCsv(const int& nrows, const int& ncols);
GCsv(const GFilename& filename, const std::string& sep = " ");
GCsv(const GCsv& csv);
virtual ~GCsv(void);
// Operators
GCsv& operator=(const GCsv& csv);
std::string& operator()(const int& row, const int& col);
const std::string& operator()(const int& row, const int& col) const;
// Methods
void clear(void);
GCsv* clone(void) const;
std::string classname(void) const;
int size(void) const;
const int& ncols(void) const;
const int& nrows(void) const;
const int& precision(void) const;
void precision(const int& precision);
void append(const std::vector<std::string>& list);
std::string string(const int& row, const int& col) const;
double real(const int& row, const int& col) const;
int integer(const int& row, const int& col) const;
void string(const int& row, const int& col, const std::string& value);
void real(const int& row, const int& col, const double& value);
void integer(const int& row, const int& col, const int& value);
void load(const GFilename& filename, const std::string& sep = " ");
void save(const GFilename& filename, const std::string& sep = " ",
const bool& clobber = false) const;
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GCsv& csv);
void free_members(void);
// Protected data members
int m_cols; //!< Number of columns
int m_rows; //!< Number of rows
std::vector<std::vector<std::string> > m_data; //!< CSV table data
int m_precision; //!< Precision for floats
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GCsv").
***************************************************************************/
inline
std::string GCsv::classname(void) const
{
return ("GCsv");
}
/***********************************************************************//**
* @brief Return table size (columns times rows)
*
* @return Table size.
***************************************************************************/
inline
int GCsv::size(void) const
{
return m_rows*m_cols;
}
/***********************************************************************//**
* @brief Return number of columns
*
* @return Number of columns.
***************************************************************************/
inline
const int& GCsv::ncols(void) const
{
return m_cols;
}
/***********************************************************************//**
* @brief Return number of rows
*
* @return Number of rows.
***************************************************************************/
inline
const int& GCsv::nrows(void) const
{
return m_rows;
}
/***********************************************************************//**
* @brief Return fixed field floating point precision
*
* @return Fixed field floating point precision.
*
* Returns the precision for floating point values when setting values using
* the real() method. Any value >0 indicates the number of decimal places
* that the floating point value will have.
***************************************************************************/
inline
const int& GCsv::precision(void) const
{
return m_precision;
}
/***********************************************************************//**
* @brief Set fixed field floating point precision
*
* @param[in] precision Fixed field floating point precision.
*
* Set the precision for floating point values when setting values using
* the real() method. Any value >0 indicates the number of decimal places
* that the floating point value will have.
***************************************************************************/
inline
void GCsv::precision(const int& precision)
{
m_precision = precision;
return;
}
#endif /* GCSV_HPP */