Main MRPT website
>
C++ reference for MRPT 1.4.0
mrpt
otherlibs
tclap
CmdLineOutput.h
Go to the documentation of this file.
1
/* +---------------------------------------------------------------------------+
2
| Mobile Robot Programming Toolkit (MRPT) |
3
| http://www.mrpt.org/ |
4
| |
5
| Copyright (c) 2005-2016, Individual contributors, see AUTHORS file |
6
| See: http://www.mrpt.org/Authors - All rights reserved. |
7
| Released under BSD License. See details in http://www.mrpt.org/License |
8
+---------------------------------------------------------------------------+ */
9
10
11
/******************************************************************************
12
*
13
* file: CmdLineOutput.h
14
*
15
* Copyright (c) 2004, Michael E. Smoot
16
* All rights reverved.
17
*
18
* See the file COPYING in the top directory of this distribution for
19
* more information.
20
*
21
* THE SOFTWARE IS PROVIDED _AS IS_, WITHOUT WARRANTY OF ANY KIND, EXPRESS
22
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27
* DEALINGS IN THE SOFTWARE.
28
*
29
*****************************************************************************/
30
31
#ifndef TCLAP_CMDLINEOUTPUT_H
32
#define TCLAP_CMDLINEOUTPUT_H
33
34
#include <string>
35
#include <vector>
36
#include <list>
37
#include <iostream>
38
#include <iomanip>
39
#include <algorithm>
40
41
namespace
TCLAP
{
42
43
class
CmdLineInterface;
44
class
ArgException;
45
46
/**
47
* The interface that any output object must implement.
48
*/
49
class
CmdLineOutput
50
{
51
52
public
:
53
54
/**
55
* Virtual destructor.
56
*/
57
virtual
~CmdLineOutput
() {}
58
59
/**
60
* Generates some sort of output for the USAGE.
61
* \param c - The CmdLine object the output is generated for.
62
*/
63
virtual
void
usage
(CmdLineInterface& c)=0;
64
65
/**
66
* Generates some sort of output for the version.
67
* \param c - The CmdLine object the output is generated for.
68
*/
69
virtual
void
version
(
CmdLineInterface
& c)=0;
70
71
/**
72
* Generates some sort of output for a failure.
73
* \param c - The CmdLine object the output is generated for.
74
* \param e - The ArgException that caused the failure.
75
*/
76
virtual
void
failure
(
CmdLineInterface
& c,
77
ArgException
& e )=0;
78
79
};
80
81
}
//namespace TCLAP
82
#endif
TCLAP::CmdLineOutput::usage
virtual void usage(CmdLineInterface &c)=0
Generates some sort of output for the USAGE.
TCLAP
Definition:
Arg.h:44
TCLAP::CmdLineOutput::version
virtual void version(CmdLineInterface &c)=0
Generates some sort of output for the version.
TCLAP::CmdLineOutput::~CmdLineOutput
virtual ~CmdLineOutput()
Virtual destructor.
Definition:
CmdLineOutput.h:73
TCLAP::ArgException
A simple class that defines and argument exception.
Definition:
ArgException.h:60
TCLAP::CmdLineInterface
The base class that manages the command line definition and passes along the parsing to the appropria...
Definition:
CmdLineInterface.h:68
TCLAP::CmdLineOutput::failure
virtual void failure(CmdLineInterface &c, ArgException &e)=0
Generates some sort of output for a failure.
Page generated by
Doxygen 1.8.16
for MRPT 1.4.0 SVN: at Mon Oct 14 23:11:08 UTC 2019