Piduino::OptionPrinter

Base class for an OptionPrinter. More...

#include <popl.h>

Inheritance diagram for Piduino::OptionPrinter:

Collaboration diagram for Piduino::OptionPrinter:

Public Member Functions
	OptionPrinter (const OptionParser *option_parser)
virtual	~OptionPrinter ()=default
	Destructor.
virtual std::string	print (const Attribute &max_attribute=Attribute::optional) const =0

Protected Attributes
const OptionParser *	option_parser_

Detailed Description

Base class for an OptionPrinter.

OptionPrinter creates a help message for a given OptionParser

Definition at line 414 of file popl.h.

Constructor & Destructor Documentation

OptionPrinter()

Piduino::OptionPrinter::OptionPrinter ( const OptionParser *  option_parser )

inlineexplicit

Constructor

Parameters

option_parser

the OptionParser to create the help message from

Definition at line 418 of file popl.h.

~OptionPrinter()

virtual Piduino::OptionPrinter::~OptionPrinter ( )

virtualdefault

Destructor.

Member Function Documentation

print()

virtual std::string Piduino::OptionPrinter::print ( const Attribute &  max_attribute = Attribute::optional ) const

pure virtual

Create a help message

Parameters

max_attribute

show options up to this level (optional, advanced, expert)

Returns

the help message

Implemented in Piduino::ConsoleOptionPrinter, Piduino::GroffOptionPrinter, and Piduino::BashCompletionOptionPrinter.

Member Data Documentation

option_parser_

const OptionParser* Piduino::OptionPrinter::option_parser_

protected

Definition at line 430 of file popl.h.

Referenced by Piduino::ConsoleOptionPrinter::print(), Piduino::GroffOptionPrinter::print(), and Piduino::BashCompletionOptionPrinter::print().