mcrl2::utilities::tools::input_output_tool
===============================================================================


Include file:

.. code-block:: c++

   #include "mcrl2/utilities/input_output_tool.h

.. cpp:class:: mcrl2::utilities::tools::input_output_tool

  Base class for tools that take a file as input, and write the results to a file. 

  

Protected attributes
-------------------------------------------------------------------------------

.. cpp:member:: std::string mcrl2::utilities::tools::input_output_tool::m_output_filename
  
  The output file name. 

  

Protected member functions
-------------------------------------------------------------------------------

.. cpp:function:: void check_positional_options(const command_line_parser &parser)
  
  Checks if the number of positional options is OK. 

  
  
  **Parameters:**

  * **parser** A command line parser 



.. cpp:function:: std::string make_tool_description(const std::string &description) const
  
  Adds a message about input and output files to the given description. 

  

.. cpp:function:: std::string output_file_message() const
  
  Returns a message about the output filename. 

  

.. cpp:function:: void parse_options(const command_line_parser &parser)
  
  Parse non-standard options. 

  
  
  **Parameters:**

  * **parser** A command line parser 



.. cpp:function:: std::string synopsis() const
  
  Returns the synopsis of the tool. 

  
      
  **Returns:** The string "[OPTION]... [INFILE [OUTFILE]]\n" 

Public member functions
-------------------------------------------------------------------------------

.. cpp:function:: input_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. 

  

.. cpp:function:: std::string& output_filename()
  
  Returns a reference to the output filename. 

  

.. cpp:function:: const std::string& output_filename() const
  
  Returns a const reference to the output filename.