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

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

refs #521. Deprecate class OptionInFile? and OptionOutFile?. Replaced OptinOutFile? with base class OptionFile? in commandline_test

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 2.0 KB
Line 
1#ifndef _theplu_yat_utility_option_ofile_
2#define _theplu_yat_utility_option_ofile_
3
4// $Id: OptionOutFile.h 2057 2009-09-11 00:11:19Z 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 "deprecate.h"
27#include "OptionFile.h"
28
29#include <iosfwd>
30#include <string>
31
32namespace theplu {
33namespace yat {
34namespace utility {
35
36  class CommandLine;
37  /**
38     \brief Class for file related options
39
40     \deprecated Provided for backward compatibility with the 0.5
41     API. Use OptionFile and StreamRedirect instead (see CommandLine
42     for example code).
43   */
44  class OptionOutFile : public OptionFile
45  {
46  public:
47    /**
48       \brief Constructor
49       
50       \param cmd Commandline Option is associated with
51       \param name string such as "file" for --file, "f" for -f or
52       "f,file" for having both short and long option name
53       \param desc string used in help display
54       \param required If true option must be found in commandline or
55       exception is thrown in validation
56    */
57    OptionOutFile(CommandLine& cmd, std::string name, std::string desc, 
58               bool required=false) YAT_DEPRECATE; 
59
60    /**
61       \brief Destructor
62    */
63    virtual ~OptionOutFile(void);
64
65    /**
66       \brief stream \a ss to underlying file. If no file was given
67       during parsing, reference to std::cout is returned.
68    */
69    std::ostream& ostream(void);
70
71  private:
72    std::ofstream* os_;
73   
74  };
75
76}}} // of namespace utility, yat, and theplu
77
78#endif
Note: See TracBrowser for help on using the repository browser.