mcrl2::pres_system::tools::pres_input_tool< Tool > Class Template Reference

Base class for filter tools that take a pres as input. More...

#include <pres_input_tool.h>

Inheritance diagram for mcrl2::pres_system::tools::pres_input_tool< Tool >:

Public Member Functions
	pres_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.
virtual	~pres_input_tool ()=default
	Destructor.
utilities::file_format	pres_input_format () const
	Returns the input file format.

Protected Member Functions
virtual std::set< utilities::file_format >	available_input_formats () const
	Returns the file formats that are available for this tool. Override this method to change the standard behavior.
virtual utilities::file_format	default_input_format () const
	Returns the default file format. Override this method to change the standard behavior.
void	add_options (utilities::interface_description &desc)
	Add options to an interface description. Also includes input format options.
void	parse_options (const utilities::command_line_parser &parser)
	Parse non-standard options.

Protected Attributes
utilities::file_format	m_pres_input_format
	The type of the pres input format.

Detailed Description

template<typename Tool>
class mcrl2::pres_system::tools::pres_input_tool< Tool >

Base class for filter tools that take a pres as input.

Precondition

Tool provides input_filename()

Definition at line 31 of file pres_input_tool.h.

Constructor & Destructor Documentation

pres_input_tool()

template<typename Tool >

mcrl2::pres_system::tools::pres_input_tool< Tool >::pres_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.

Parameters

name	The name of the tool
author	The author(s) of the tool
what_is	One-line "what is" description of the tool
tool_description	The description of the tool
known_issues	Known issues with the tool

Definition at line 116 of file pres_input_tool.h.

~pres_input_tool()

template<typename Tool >

virtual mcrl2::pres_system::tools::pres_input_tool< Tool >::~pres_input_tool ( )

virtualdefault

Destructor.

Member Function Documentation

add_options()

template<typename Tool >

void mcrl2::pres_system::tools::pres_input_tool< Tool >::add_options ( utilities::interface_description &  desc )

inlineprotected

Add options to an interface description. Also includes input format options.

Parameters

desc	An interface description

Definition at line 66 of file pres_input_tool.h.

available_input_formats()

template<typename Tool >

virtual std::set< utilities::file_format > mcrl2::pres_system::tools::pres_input_tool< Tool >::available_input_formats ( ) const

inlineprotectedvirtual

Returns the file formats that are available for this tool. Override this method to change the standard behavior.

Returns

The set { pres, res }

Definition at line 41 of file pres_input_tool.h.

default_input_format()

template<typename Tool >

virtual utilities::file_format mcrl2::pres_system::tools::pres_input_tool< Tool >::default_input_format ( ) const

inlineprotectedvirtual

Returns the default file format. Override this method to change the standard behavior.

Returns

The file format based on the extension of the input file, or if it is not possible to

Definition at line 53 of file pres_input_tool.h.

parse_options()

template<typename Tool >

void mcrl2::pres_system::tools::pres_input_tool< Tool >::parse_options ( const utilities::command_line_parser &  parser )

inlineprotected

Parse non-standard options.

Parameters

parser

A command line parser

Definition at line 80 of file pres_input_tool.h.

pres_input_format()

template<typename Tool >

utilities::file_format mcrl2::pres_system::tools::pres_input_tool< Tool >::pres_input_format ( ) const

inline

Returns the input file format.

Returns

The input format

Definition at line 130 of file pres_input_tool.h.

Member Data Documentation

m_pres_input_format

template<typename Tool >

utilities::file_format mcrl2::pres_system::tools::pres_input_tool< Tool >::m_pres_input_format

protected

The type of the pres input format.

Definition at line 36 of file pres_input_tool.h.

---

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

• pres/include/mcrl2/pres/pres_input_tool.h