catapult::tools::Tool Class Reference

Interface for the tools. More...

Inheritance diagram for catapult::tools::Tool:

Collaboration diagram for catapult::tools::Tool:

Public Member Functions
virtual bool	allowUnregisteredOptions () const
	Tool should return true if command line parser should allow unregistered options. More...
virtual CommandParser *	subCommandParser (const Options &) const
	Tool should return sub command parser. More...
virtual int	run (const Options &options)=0
	Run the tool passing options collected from the command line. More...
Public Member Functions inherited from catapult::tools::CommandParser
virtual	~CommandParser ()=default
virtual std::string	name () const =0
	Returns name of the command. More...
virtual void	prepareOptions (OptionsBuilder &optionsBuilder, OptionsPositional &positional)=0
	Prepare named (optionsBuilder) and positional options of the tool. More...

Detailed Description

Interface for the tools.

Member Function Documentation

allowUnregisteredOptions()

virtual bool catapult::tools::Tool::allowUnregisteredOptions ( ) const

inlinevirtual

Tool should return true if command line parser should allow unregistered options.

run()

virtual int catapult::tools::Tool::run ( const Options &  options )

pure virtual

Run the tool passing options collected from the command line.

Implemented in catapult::tools::NetworkCensusTool< TNodeInfo >.

Here is the caller graph for this function:

subCommandParser()

virtual CommandParser* catapult::tools::Tool::subCommandParser ( const Options &  ) const

inlinevirtual

Tool should return sub command parser.

---

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

• Tool.h