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
|
// -*- Mode: C++; tab-width: 2; -*-
// vi: set ts=2:
//
// $Id: parameters.h,v 1.18 2005/12/23 17:01:46 amoll Exp $
// general parameter file class
//
#ifndef BALL_FORMAT_PARAMETERS_H
#define BALL_FORMAT_PARAMETERS_H
#ifndef BALL_FORMAT_INIFILE_H
# include <BALL/FORMAT/INIFile.h>
#endif
namespace BALL
{
/** General Parameter class.
This class is intended to simplify parameter management
for force fields or other stronlgy parameterized methods.
It is based on \link INIFile INIFile \endlink . \par
\ingroup General
*/
class BALL_EXPORT Parameters
{
public:
BALL_CREATE(Parameters)
/** @name Constructors and destructor
*/
//@{
/** Default constructor.
*/
Parameters();
/** Constructor.
*/
Parameters(const String& filename);
/** Copy constructor
*/
Parameters(const Parameters& force_field_parameter);
/** Destructor.
*/
virtual ~Parameters();
/** Clear method.
*/
virtual void clear()
;
//@}
/** @name Assignment
*/
//@{
/** Assignment operator
*/
const Parameters& operator = (const Parameters& parameters);
//@}
/** @name Accessors
*/
//@{
/** Sets the filename for the INI file.
*/
void setFilename(const String& filename);
/** Return the current INI file's name.
*/
const String& getFilename() const;
/** Return a reference to the INI file.
*/
INIFile& getParameterFile();
/** Read the contents of the INI file and interpret them.
*/
bool init();
//@}
/** @name Predicates
*/
//@{
/** Validity predicate.
Return <b>true</b> if the parameters were correctly
initialized, the internal INI file is valid.
@return bool - <tt>valid_ && parameter_file_.isValid()</tt>
*/
virtual bool isValid() const;
/** Equality operator
*/
bool operator == (const Parameters& parameters) const;
//@}
protected:
/*_ @name Protected Members
*/
//_@{
/*_
*/
bool valid_;
/*_ the INIFile
*/
INIFile INI_file_;
//_@}
};
} // namespace BALL
#endif // BALL_FORMAT_PARAMETERS_H
|
