mcrl2::utilities::tools::parallel_tool< Tool > Class Template Reference

Base class for tools that are using multiple threads. More...

#include <parallel_tool.h>

Inheritance diagram for mcrl2::utilities::tools::parallel_tool< Tool >:

Public Member Functions
	parallel_tool (const std::string &name, const std::string &author, const std::string &what_is, const std::string &tool_description, std::string known_issues="")
	Constructor.
std::size_t	number_of_threads () const
	Returns the number of threads in this tool.

Protected Member Functions
void	add_options (utilities::interface_description &desc)
	Add the –threads option to an interface description.
void	parse_options (const utilities::command_line_parser &parser)
	Parse non-standard options.

Protected Attributes
std::size_t	m_number_of_threads =1
	The number of threads in the parallel tool.

Detailed Description

template<typename Tool>
class mcrl2::utilities::tools::parallel_tool< Tool >

Base class for tools that are using multiple threads.

Definition at line 29 of file parallel_tool.h.

Constructor & Destructor Documentation

parallel_tool()

template<typename Tool >

mcrl2::utilities::tools::parallel_tool< Tool >::parallel_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 76 of file parallel_tool.h.

Member Function Documentation

add_options()

template<typename Tool >

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

inlineprotected

Add the –threads option to an interface description.

Parameters

desc	An interface description

Definition at line 37 of file parallel_tool.h.

number_of_threads()

template<typename Tool >

std::size_t mcrl2::utilities::tools::parallel_tool< Tool >::number_of_threads ( ) const

inline

Returns the number of threads in this tool.

Returns

The number of threads.

Definition at line 87 of file parallel_tool.h.

parse_options()

template<typename Tool >

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

inlineprotected

Parse non-standard options.

Parameters

parser

A command line parser

Definition at line 53 of file parallel_tool.h.

Member Data Documentation

m_number_of_threads

template<typename Tool >

std::size_t mcrl2::utilities::tools::parallel_tool< Tool >::m_number_of_threads =1

protected

The number of threads in the parallel tool.

Definition at line 33 of file parallel_tool.h.

---

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

• utilities/include/mcrl2/utilities/parallel_tool.h