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

Last change on this file since 1452 was 1452, checked in by Peter, 13 years ago

docs typo

  • 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 1452 2008-08-28 21:48:30Z peter $
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 2 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 this program; if not, write to the Free Software
23  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
24  02111-1307, USA.
25*/
26
27#include "OptionFile.h"
28
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.