source: trunk/yat/utility/OptionSwitch.h @ 1707

Last change on this file since 1707 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: 2.0 KB
Line 
1#ifndef _theplu_yat_utility_option_switch_
2#define _theplu_yat_utility_option_switch_
3
4// $Id: OptionSwitch.h 1487 2008-09-10 08:41:36Z jari $
5
6/*
7  Copyright (C) 2007 Jari Häkkinen, 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 "Option.h"
26
27#include <string>
28
29namespace theplu {
30namespace yat {
31namespace utility {
32
33  class CommandLine;
34  /**
35     \brief Class for switch option
36   */
37  class OptionSwitch : public Option
38  {
39  public:
40    /**
41       \brief Constructor
42       
43       \param cmd Commandline Option is associated with
44       \param name string such as "help" for --help, "h" for -h or
45       "h,help" for having both short and long option name
46       \param desc string used in help display
47       \param def default value for switch
48    */
49    OptionSwitch(CommandLine& cmd, std::string name, 
50                 std::string desc, bool def=false); 
51
52
53    /**
54       \brief return value
55     */
56    bool value(void) const;
57
58  private:
59    /**
60     */
61    void do_parse(std::vector<std::string>::iterator&, 
62                  const std::vector<std::string>::iterator&);
63
64    /**
65       called inside do_parse and allows inherited classes to add
66       stuff to do_parse.
67     */
68    virtual void do_parse2(std::vector<std::string>::iterator, 
69                           std::vector<std::string>::iterator);
70
71    /**
72     */
73    std::string print2(void) const;
74
75    /**
76     */
77    void do_validate(void) const;
78
79  private:
80    bool def_;
81    bool switch_;
82  };
83
84}}} // of namespace utility, yat, and theplu
85
86#endif
Note: See TracBrowser for help on using the repository browser.