source: trunk/yat/utility/OptionOutFile.h @ 1598

Last change on this file since 1598 was 1487, checked in by Jari Häkkinen, 13 years ago

Addresses #436. GPL license copy reference should also be updated.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 1.8 KB
Line 
1#ifndef _theplu_yat_utility_option_ofile_
2#define _theplu_yat_utility_option_ofile_
3
4// $Id: OptionOutFile.h 1487 2008-09-10 08:41:36Z jari $
5
6/*
7  Copyright (C) 2008 Peter Johansson
8
9  This file is part of the yat library, http://dev.thep.lu.se/yat
10
11  The yat library is free software; you can redistribute it and/or
12  modify it under the terms of the GNU General Public License as
13  published by the Free Software Foundation; either version 3 of the
14  License, or (at your option) any later version.
15
16  The yat library is distributed in the hope that it will be useful,
17  but WITHOUT ANY WARRANTY; without even the implied warranty of
18  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19  General Public License for more details.
20
21  You should have received a copy of the GNU General Public License
22  along with yat. If not, see <http://www.gnu.org/licenses/>.
23*/
24
25#include "OptionFile.h"
26
27#include <string>
28
29namespace theplu {
30namespace yat {
31namespace utility {
32
33  class CommandLine;
34  /**
35     \brief Class for file related options
36   */
37  class OptionOutFile : public OptionFile
38  {
39  public:
40    /**
41       \brief Constructor
42       
43       \param cmd Commandline Option is associated with
44       \param name string such as "file" for --file, "f" for -f or
45       "f,file" for having both short and long option name
46       \param desc string used in help display
47       \param required If true option must be found in commandline or
48       exception is thrown in validation
49    */
50    OptionOutFile(CommandLine& cmd, std::string name, std::string desc, 
51               bool required=false); 
52
53    /**
54       \brief Destructor
55    */
56    virtual ~OptionOutFile(void);
57
58    /**
59       \brief stream \a ss to underlying file. If no file was given
60       during parsing, reference to std::cout is returned.
61    */
62    std::ostream& ostream(void);
63
64  private:
65    std::ofstream* os_;
66   
67  };
68
69}}} // of namespace utility, yat, and theplu
70
71#endif
Note: See TracBrowser for help on using the repository browser.