HPCToolkit
ArgsHPCProf.hpp
Go to the documentation of this file.
1 // -*-Mode: C++;-*-
2 
3 // * BeginRiceCopyright *****************************************************
4 //
5 // $HeadURL$
6 // $Id$
7 //
8 // --------------------------------------------------------------------------
9 // Part of HPCToolkit (hpctoolkit.org)
10 //
11 // Information about sources of support for research and development of
12 // HPCToolkit is at 'hpctoolkit.org' and in 'README.Acknowledgments'.
13 // --------------------------------------------------------------------------
14 //
15 // Copyright ((c)) 2002-2019, Rice University
16 // All rights reserved.
17 //
18 // Redistribution and use in source and binary forms, with or without
19 // modification, are permitted provided that the following conditions are
20 // met:
21 //
22 // * Redistributions of source code must retain the above copyright
23 // notice, this list of conditions and the following disclaimer.
24 //
25 // * Redistributions in binary form must reproduce the above copyright
26 // notice, this list of conditions and the following disclaimer in the
27 // documentation and/or other materials provided with the distribution.
28 //
29 // * Neither the name of Rice University (RICE) nor the names of its
30 // contributors may be used to endorse or promote products derived from
31 // this software without specific prior written permission.
32 //
33 // This software is provided by RICE and contributors "as is" and any
34 // express or implied warranties, including, but not limited to, the
35 // implied warranties of merchantability and fitness for a particular
36 // purpose are disclaimed. In no event shall RICE or contributors be
37 // liable for any direct, indirect, incidental, special, exemplary, or
38 // consequential damages (including, but not limited to, procurement of
39 // substitute goods or services; loss of use, data, or profits; or
40 // business interruption) however caused and on any theory of liability,
41 // whether in contract, strict liability, or tort (including negligence
42 // or otherwise) arising in any way out of the use of this software, even
43 // if advised of the possibility of such damage.
44 //
45 // ******************************************************* EndRiceCopyright *
46 
47 //***************************************************************************
48 //
49 // File:
50 // $HeadURL$
51 //
52 // Purpose:
53 // [The purpose of this file]
54 //
55 // Description:
56 // [The set of functions, macros, etc. defined in the file]
57 //
58 //***************************************************************************
59 
60 #ifndef Analysis_ArgsHPCProf_hpp
61 #define Analysis_ArgsHPCProf_hpp
62 
63 //************************* System Include Files ****************************
64 
65 #include <iostream>
66 #include <string>
67 #include <vector>
68 
69 //*************************** User Include Files ****************************
70 
71 #include <include/uint.h>
72 
73 #include "Args.hpp"
74 
76 
77 //*************************** Forward Declarations **************************
78 
79 //***************************************************************************
80 
81 namespace Analysis {
82 
84  : public Analysis::Args
85 {
86 public:
87  ArgsHPCProf();
88  virtual ~ArgsHPCProf();
89 
90  // Parse the command line
91  virtual void
92  parse(int argc, const char* const argv[]);
93 
94  // Version and Usage information
95  void
96  printVersion(std::ostream& os) const;
97 
98  void
99  printUsage(std::ostream& os) const;
100 
101  // Error
102  void
103  printError(std::ostream& os, const char* msg) const;
104 
105  void
106  printError(std::ostream& os, const std::string& msg) const;
107 
108  // Dump
109  virtual void
110  dump(std::ostream& os = std::cerr) const;
111 
112 public:
113  // Parsed Data: Command
114  virtual const std::string
115  getCmd() const = 0;
116 
117 protected:
118  bool
119  parseArg_norm(const std::string& value, const char* errTag);
120 
121  void
122  parseArg_metric(const std::string& value, const char* errTag);
123 
124 
125  static std::string
126  makeDBDirName(const std::string& profileArg);
127 
128 protected:
131 };
132 
133 } // namespace Analysis
134 
135 
136 #endif // Analysis_ArgsHPCProf_hpp
virtual void dump(std::ostream &os=std::cerr) const
bool parseArg_norm(const std::string &value, const char *errTag)
void printError(std::ostream &os, const char *msg) const
void parseArg_metric(const std::string &value, const char *errTag)
virtual void parse(int argc, const char *const argv[])
void printUsage(std::ostream &os) const
static std::string makeDBDirName(const std::string &profileArg)
CmdLineParser parser
static CmdLineParser::OptArgDesc optArgs[]
virtual const std::string getCmd() const =0
void printVersion(std::ostream &os) const