Base class for tools that take two files as input. More...
#include <input_input_tool.h>
Public Member Functions | |
| input_input_tool (const std::string &name, const std::string &author, const std::string &what_is, const std::string &tool_description, std::string known_issues="") | |
| Constructor. | |
| const std::string & | input_filename1 () const |
| Returns a const reference to the first input filename. | |
| std::string & | input_filename1 () |
| Returns a reference to the first input filename. | |
| const std::string & | input_filename2 () const |
| Returns a const reference to the second input filename. | |
| std::string & | input_filename2 () |
| Returns a reference to the first second filename. | |
 Public Member Functions inherited from mcrl2::utilities::tools::tool | |
| tool (const std::string &name, const std::string &author, const std::string &what_is, const std::string &tool_description, std::string known_issues="") | |
| Constructor. | |
| virtual | ~tool () |
| Destructor. | |
| virtual bool | run ()=0 |
| Run the tool. The options must be set manually. | |
| const std::string & | timing_filename () const |
| Return the filename in which timings must be saved. | |
| execution_timer & | timer () |
| Return reference to the timer that can be used. | |
| int | execute (int argc, char *argv[]) |
| Run the tool with the given command line options. | |
Protected Member Functions | |
| void | check_positional_options (const command_line_parser &parser) |
| Checks if the number of positional options is OK. | |
| std::string | synopsis () const |
| Returns the synopsis of the tool. | |
| void | parse_options (const command_line_parser &parser) |
| Parse non-standard options. | |
| std::string | input_file_message () const |
| Returns a message about the input filename. | |
| std::string | make_tool_description (const std::string &description) const |
| Adds a message about input and output files to the given description. | |
| Protected Member Functions inherited from mcrl2::utilities::tools::tool | |
| virtual void | add_options (interface_description &desc) |
| Add options to an interface description. | |
| virtual void | parse_options (const command_line_parser &parser) |
| Parse non-standard options. | |
| virtual bool | pre_run (int &, char **) |
| Executed only if run would be executed and invoked before run. | |
| virtual void | check_standard_options (const command_line_parser &parser) |
| Parse standard options. | |
| virtual void | check_positional_options (const command_line_parser &parser) |
| Checks if the number of positional options is OK. By default this function handles standard options: -v, -d and -q Furthermore, it checks that all options occur at most once. | |
| virtual std::string | synopsis () const |
| Returns the synopsis of the tool. | |
Protected Attributes | |
| std::string | m_input_filename1 |
| The first input file name. | |
| std::string | m_input_filename2 |
| The second input file name. | |
| Protected Attributes inherited from mcrl2::utilities::tools::tool | |
| std::string | m_name |
| The name of the tool. | |
| std::string | m_author |
| The name of the developer(s) | |
| std::string | m_what_is |
| One-line "what is" description of the tool. | |
| std::string | m_tool_description |
| The description of the tool. | |
| std::string | m_known_issues |
| Known issues of the tool. | |
| std::string | m_timing_filename |
| The filename to which timings must be written. | |
| execution_timer | m_timer |
| The timer which can be used by the tools. | |
| bool | m_timing_enabled |
| Determines whether timing output should be written. | |
Detailed Description
Base class for tools that take two files as input.
Definition at line 27 of file input_input_tool.h.
Constructor & Destructor Documentation
◆ input_input_tool()
|
inline |
Constructor.
Definition at line 83 of file input_input_tool.h.
Member Function Documentation
◆ check_positional_options()
|
inlineprotectedvirtual |
Checks if the number of positional options is OK.
- Parameters
-
parser A command line parser
Reimplemented from mcrl2::utilities::tools::tool.
Definition at line 38 of file input_input_tool.h.
◆ input_file_message()
|
inlineprotected |
Returns a message about the input filename.
Definition at line 68 of file input_input_tool.h.
◆ input_filename1() [1/2]
|
inline |
Returns a reference to the first input filename.
Definition at line 100 of file input_input_tool.h.
◆ input_filename1() [2/2]
|
inline |
Returns a const reference to the first input filename.
Definition at line 94 of file input_input_tool.h.
◆ input_filename2() [1/2]
|
inline |
Returns a reference to the first second filename.
Definition at line 112 of file input_input_tool.h.
◆ input_filename2() [2/2]
|
inline |
Returns a const reference to the second input filename.
Definition at line 106 of file input_input_tool.h.
◆ make_tool_description()
|
inlineprotected |
Adds a message about input and output files to the given description.
Definition at line 76 of file input_input_tool.h.
◆ parse_options()
|
inlineprotectedvirtual |
Parse non-standard options.
- Parameters
-
parser A command line parser
Reimplemented from mcrl2::utilities::tools::tool.
Definition at line 54 of file input_input_tool.h.
◆ synopsis()
|
inlineprotectedvirtual |
Returns the synopsis of the tool.
Reimplemented from mcrl2::utilities::tools::tool.
Definition at line 47 of file input_input_tool.h.
Member Data Documentation
◆ m_input_filename1
|
protected |
The first input file name.
Definition at line 31 of file input_input_tool.h.
◆ m_input_filename2
|
protected |
The second input file name.
Definition at line 34 of file input_input_tool.h.
The documentation for this class was generated from the following file:
- utilities/include/mcrl2/utilities/input_input_tool.h
