GApplicationPars.hpp
7.77 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
193
194
195
196
197
198
/***************************************************************************
* GApplicationPars.hpp - Application parameters *
* ----------------------------------------------------------------------- *
* 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 GApplicationPars.hpp
* @brief Application parameter container class definition
* @author Juergen Knoedlseder
*/
#ifndef GAPPLICATIONPARS_HPP
#define GAPPLICATIONPARS_HPP
/* __ Includes ___________________________________________________________ */
#include <vector>
#include <string>
#include "GContainer.hpp"
#include "GApplicationPar.hpp"
/* __ Forward declarations _______________________________________________ */
class GFilename;
/***********************************************************************//**
* @class GApplicationPars
*
* @brief Application parameter container class
*
* This class holds a collection of application parameters.
***************************************************************************/
class GApplicationPars : public GContainer {
// Friend classes
friend class GApplication;
public:
// Constructors and destructors
GApplicationPars(void);
explicit GApplicationPars(const GFilename& filename);
GApplicationPars(const GFilename& filename,
const std::vector<std::string>& args);
GApplicationPars(const GApplicationPars& pars);
virtual ~GApplicationPars(void);
// Operators
GApplicationPars& operator=(const GApplicationPars& pars);
GApplicationPar& operator[](const int& index);
const GApplicationPar& operator[](const int& index) const;
GApplicationPar& operator[](const std::string& name);
const GApplicationPar& operator[](const std::string& name) const;
// Methods
void clear(void);
GApplicationPars* clone(void) const;
std::string classname(void) const;
GApplicationPar& at(const int& index);
const GApplicationPar& at(const int& index) const;
int size(void) const;
bool is_empty(void) const;
GApplicationPar& append(const GApplicationPar& par);
void append_standard(void);
GApplicationPar& insert(const int& index, const GApplicationPar& par);
GApplicationPar& insert(const std::string& name,
const GApplicationPar& par);
void remove(const int& index);
void remove(const std::string& name);
void reserve(const int& num);
void extend(const GApplicationPars& pars);
bool contains(const std::string& name) const;
void load(const GFilename& filename);
void load(const GFilename& filename,
const std::vector<std::string>& args);
void save(const GFilename& filename);
std::string print(const GChatter& chatter = NORMAL) const;
protected:
// Protected methods
void init_members(void);
void copy_members(const GApplicationPars& pars);
void free_members(void);
std::string inpath(const std::string& filename) const;
std::string outpath(const std::string& filename) const;
void read(const std::string& filename);
void write(const std::string& filename) const;
void parse(void);
void update(void);
int get_index(const std::string& name) const;
std::string parline(GApplicationPar& par, size_t* start, size_t* stop) const;
// Protected data members
std::vector<std::string> m_parfile; //!< Parameter file lines
std::vector<GApplicationPar> m_pars; //!< Parameters
std::vector<int> m_line; //!< Line number of parameter
std::vector<size_t> m_vstart; //!< Column of value start
std::vector<size_t> m_vstop; //!< Column of value stop
std::string m_mode; //!< Effective mode
};
/***********************************************************************//**
* @brief Return class name
*
* @return String containing the class name ("GApplicationPars").
***************************************************************************/
inline
std::string GApplicationPars::classname(void) const
{
return ("GApplicationPars");
}
/***********************************************************************//**
* @brief Returns reference to parameter
*
* @param[in] index Parameter index [0,...,size()-1].
*
* Returns a reference to the parameter with the specified @p index.
***************************************************************************/
inline
GApplicationPar& GApplicationPars::operator[](const int& index)
{
return (m_pars[index]);
}
/***********************************************************************//**
* @brief Returns reference to parameter (const version)
*
* @param[in] index Parameter index [0,...,size()-1].
*
* Returns a reference to the parameter with the specified @p index.
***************************************************************************/
inline
const GApplicationPar& GApplicationPars::operator[](const int& index) const
{
return (m_pars[index]);
}
/***********************************************************************//**
* @brief Return number of parameters in container
*
* @return Number of parameters in container.
*
* Returns the number of parameters in the parameter container.
***************************************************************************/
inline
int GApplicationPars::size(void) const
{
return (int)m_pars.size();
}
/***********************************************************************//**
* @brief Signals if there are no parameters in container
*
* @return True if container is empty, false otherwise.
*
* Signals if the parameter container does not contain any parameter.
***************************************************************************/
inline
bool GApplicationPars::is_empty(void) const
{
return (m_pars.empty());
}
/***********************************************************************//**
* @brief Reserves space for parameters in container
*
* @param[in] num Number of parameter
*
* Reserves space for @p num parameters in the container.
***************************************************************************/
inline
void GApplicationPars::reserve(const int& num)
{
m_pars.reserve(num);
return;
}
#endif /* GAPPLICATIONPARS_HPP */