mcrl2::utilities::tools::input_tool Class Reference

Base class for tools that take a file as input. More...

#include <input_tool.h>

Inheritance diagram for mcrl2::utilities::tools::input_tool:

Public Member Functions
	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_filename () const
	Returns a const reference to the input filename.
std::string &	input_filename ()
	Returns a reference to the input 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) override
	Checks if the number of positional options is OK.
std::string	synopsis () const override
	Returns the synopsis of the tool.
void	parse_options (const command_line_parser &parser) override
	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 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_filename
	The 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 a file as input.

Definition at line 27 of file input_tool.h.

Constructor & Destructor Documentation

input_tool()

mcrl2::utilities::tools::input_tool::input_tool ( const std::string &  name, const std::string &  author, const std::string &  what_is, const std::string &  tool_description, std::string  known_issues = ""  )

inline

Constructor.

Definition at line 78 of file input_tool.h.

Member Function Documentation

check_positional_options()

void mcrl2::utilities::tools::input_tool::check_positional_options ( const command_line_parser &  parser )

inlineoverrideprotectedvirtual

Checks if the number of positional options is OK.

Parameters

parser

A command line parser

Reimplemented from mcrl2::utilities::tools::tool.

Definition at line 35 of file input_tool.h.

input_file_message()

std::string mcrl2::utilities::tools::input_tool::input_file_message ( ) const

inlineprotected

Returns a message about the input filename.

Definition at line 62 of file input_tool.h.

input_filename() [1/2]

std::string & mcrl2::utilities::tools::input_tool::input_filename ( )

inline

Returns a reference to the input filename.

Definition at line 95 of file input_tool.h.

input_filename() [2/2]

const std::string & mcrl2::utilities::tools::input_tool::input_filename ( ) const

inline

Returns a const reference to the input filename.

Definition at line 89 of file input_tool.h.

make_tool_description()

std::string mcrl2::utilities::tools::input_tool::make_tool_description ( const std::string &  description ) const

inlineprotected

Adds a message about input files to the given description.

Definition at line 70 of file input_tool.h.

parse_options()

void mcrl2::utilities::tools::input_tool::parse_options ( const command_line_parser &  parser )

inlineoverrideprotectedvirtual

Parse non-standard options.

Parameters

parser

A command line parser

Reimplemented from mcrl2::utilities::tools::tool.

Definition at line 52 of file input_tool.h.

synopsis()

std::string mcrl2::utilities::tools::input_tool::synopsis ( ) const

inlineoverrideprotectedvirtual

Returns the synopsis of the tool.

Returns

The string "[OPTION]... [INFILE]\n"

Reimplemented from mcrl2::utilities::tools::tool.

Definition at line 45 of file input_tool.h.

Member Data Documentation

m_input_filename

std::string mcrl2::utilities::tools::input_tool::m_input_filename

protected

The input file name.

Definition at line 31 of file input_tool.h.

---

The documentation for this class was generated from the following file:

• utilities/include/mcrl2/utilities/input_tool.h