mcrl2::pbes_system::tools::pbes_output_tool< Tool > Class Template Reference

Base class for filter tools that produce a pbes as output. More...

#include <pbes_output_tool.h>

Inheritance diagram for mcrl2::pbes_system::tools::pbes_output_tool< Tool >:

Public Member Functions
	pbes_output_tool (const std::string &name, const std::string &author, const std::string &what_is, const std::string &tool_description, std::string known_issues="")
	Constructor.
	~pbes_output_tool () override=default
	Destructor.
utilities::file_format	pbes_output_format () const
	Returns the output format.

Protected Member Functions
virtual std::set< utilities::file_format >	available_output_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_output_format () const
	Returns the default file format. Override this method to change the standard behavior.
void	add_options (utilities::interface_description &desc) override
	Add options to an interface description. Also includes output format options.
void	parse_options (const utilities::command_line_parser &parser) override
	Parse non-standard options.

Protected Attributes
utilities::file_format	m_pbes_output_format
	The type of the pbes output format.

Detailed Description

template<typename Tool>
class mcrl2::pbes_system::tools::pbes_output_tool< Tool >

Base class for filter tools that produce a pbes as output.

Precondition

Tool provides output_filename()

Definition at line 28 of file pbes_output_tool.h.

Constructor & Destructor Documentation

pbes_output_tool()

template<typename Tool >

mcrl2::pbes_system::tools::pbes_output_tool< Tool >::pbes_output_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 115 of file pbes_output_tool.h.

~pbes_output_tool()

template<typename Tool >

mcrl2::pbes_system::tools::pbes_output_tool< Tool >::~pbes_output_tool ( )

overridedefault

Destructor.

Member Function Documentation

add_options()

template<typename Tool >

void mcrl2::pbes_system::tools::pbes_output_tool< Tool >::add_options ( utilities::interface_description &  desc )

inlineoverrideprotected

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

Parameters

desc	An interface description

Definition at line 65 of file pbes_output_tool.h.

available_output_formats()

template<typename Tool >

virtual std::set< utilities::file_format > mcrl2::pbes_system::tools::pbes_output_tool< Tool >::available_output_formats ( ) const

inlineprotectedvirtual

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

Returns

The set { pbes, text }

Definition at line 38 of file pbes_output_tool.h.

default_output_format()

template<typename Tool >

virtual utilities::file_format mcrl2::pbes_system::tools::pbes_output_tool< Tool >::default_output_format ( ) const

inlineprotectedvirtual

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

Returns

The default format is determined based on the extension of the output file.

Definition at line 52 of file pbes_output_tool.h.

parse_options()

template<typename Tool >

void mcrl2::pbes_system::tools::pbes_output_tool< Tool >::parse_options ( const utilities::command_line_parser &  parser )

inlineoverrideprotected

Parse non-standard options.

Parameters

parser

A command line parser

Definition at line 79 of file pbes_output_tool.h.

pbes_output_format()

template<typename Tool >

utilities::file_format mcrl2::pbes_system::tools::pbes_output_tool< Tool >::pbes_output_format ( ) const

inline

Returns the output format.

Returns

The output format

Definition at line 128 of file pbes_output_tool.h.

Member Data Documentation

m_pbes_output_format

template<typename Tool >

utilities::file_format mcrl2::pbes_system::tools::pbes_output_tool< Tool >::m_pbes_output_format

protected

The type of the pbes output format.

Definition at line 33 of file pbes_output_tool.h.

---

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

• pbes/include/mcrl2/pbes/pbes_output_tool.h