BALL::Parameters Class Reference
[General Purpose File Formats]
#include <BALL/FORMAT/parameters.h>
Public Member Functions | |
Constructors and destructor | |
| Parameters () | |
| Parameters (const String &filename) | |
| Parameters (const Parameters &force_field_parameter) | |
| virtual | ~Parameters () |
| virtual void | clear () |
Assignment | |
| const Parameters & | operator= (const Parameters ¶meters) |
Accessors | |
| void | setFilename (const String &filename) |
| const String & | getFilename () const |
| INIFile & | getParameterFile () |
| bool | init () |
Predicates | |
| virtual bool | isValid () const |
| bool | operator== (const Parameters ¶meters) const |
Protected Attributes | |
| bool | valid_ |
| INIFile | INI_file_ |
Detailed Description
General Parameter class. This class is intended to simplify parameter management for force fields or other stronlgy parameterized methods. It is based on INIFile .
Definition at line 24 of file parameters.h.
Constructor & Destructor Documentation
| BALL::Parameters::Parameters | ( | ) |
Default constructor.
| BALL::Parameters::Parameters | ( | const String & | filename | ) |
Constructor.
| BALL::Parameters::Parameters | ( | const Parameters & | force_field_parameter | ) |
Copy constructor
| virtual BALL::Parameters::~Parameters | ( | ) | [virtual] |
Destructor.
Member Function Documentation
| virtual void BALL::Parameters::clear | ( | ) | [virtual] |
Clear method.
Reimplemented in BALL::ForceFieldParameters.
| const String& BALL::Parameters::getFilename | ( | ) | const |
Return the current INI file's name.
| INIFile& BALL::Parameters::getParameterFile | ( | ) |
Return a reference to the INI file.
| bool BALL::Parameters::init | ( | ) |
Read the contents of the INI file and interpret them.
Reimplemented in BALL::ForceFieldParameters.
| virtual bool BALL::Parameters::isValid | ( | ) | const [virtual] |
Validity predicate. Return true if the parameters were correctly initialized, the internal INI file is valid.
- Returns:
- bool -
valid_ && parameter_file_.isValid()
Reimplemented in BALL::ForceFieldParameters.
| const Parameters& BALL::Parameters::operator= | ( | const Parameters & | parameters | ) |
Assignment operator
| bool BALL::Parameters::operator== | ( | const Parameters & | parameters | ) | const |
Equality operator
| void BALL::Parameters::setFilename | ( | const String & | filename | ) |
Sets the filename for the INI file.
Member Data Documentation
INIFile BALL::Parameters::INI_file_ [protected] |
Definition at line 115 of file parameters.h.
bool BALL::Parameters::valid_ [protected] |
Definition at line 111 of file parameters.h.
