3 * This source code is part of
7 * GROningen MAchine for Chemical Simulations
9 * Written by David van der Spoel, Erik Lindahl, Berk Hess, and others.
10 * Copyright (c) 1991-2000, University of Groningen, The Netherlands.
11 * Copyright (c) 2001-2009, The GROMACS development team,
12 * check out http://www.gromacs.org for more information.
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License
16 * as published by the Free Software Foundation; either version 2
17 * of the License, or (at your option) any later version.
19 * If you want to redistribute modifications, please consider that
20 * scientific software is very special. Version control is crucial -
21 * bugs must be traceable. We will be happy to consider code for
22 * inclusion in the official distribution, but derived work must not
23 * be called official GROMACS. Details are found in the README & COPYING
24 * files - if they are missing, get the official version at www.gromacs.org.
26 * To help us fund GROMACS development, we humbly ask that you cite
27 * the papers on the package - you can find them in the top README file.
29 * For more info, check our website at http://www.gromacs.org
33 * Declares gmx::FileNameOptionStorage.
35 * \author Teemu Murtola <teemu.murtola@cbr.su.se>
36 * \ingroup module_options
38 #ifndef GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
39 #define GMX_OPTIONS_FILENAMEOPTIONSTORAGE_H
43 #include "filenameoption.h"
44 #include "optionfiletype.h"
45 #include "optionstoragetemplate.h"
53 * Converts, validates, and stores file names.
55 class FileNameOptionStorage : public OptionStorageTemplate<std::string>
58 //! \copydoc StringOptionStorage::StringOptionStorage()
59 explicit FileNameOptionStorage(const FileNameOption &settings);
61 virtual OptionInfo &optionInfo() { return info_; }
62 virtual const char *typeString() const { return "file"; }
63 virtual std::string formatSingleValue(const std::string &value) const;
65 //! \copydoc FileNameOptionInfo::isInputFile()
66 bool isInputFile() const { return bRead_ && !bWrite_; }
67 //! \copydoc FileNameOptionInfo::isOutputFile()
68 bool isOutputFile() const { return !bRead_ && bWrite_; }
69 //! \copydoc FileNameOptionInfo::isInputOutputFile()
70 bool isInputOutputFile() const { return bRead_ && bWrite_; }
71 //! \copydoc FileNameOptionInfo::isLibraryFile()
72 bool isLibraryFile() const { return bLibrary_; }
75 virtual void convertValue(const std::string &value);
77 FileNameOptionInfo info_;
78 OptionFileType filetype_;