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

Last change on this file since 1805 was 1805, checked in by Peter, 12 years ago

added missing include

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