ROSE 0.11.145.317
Public Types | Static Public Member Functions | Protected Member Functions | List of all members
Sawyer::CommandLine::ShowVersion Class Reference

Description

Functor to print a version string.

The string supplied to the constructor is printed to standard error followed by a line feed. Although the string is intended to be a version number, it can be anything you like. Sometimes people use this action to aid debugging of the parsing.

Definition at line 1614 of file Sawyer/CommandLine.h.

#include <Sawyer/CommandLine.h>

Inheritance diagram for Sawyer::CommandLine::ShowVersion:
Inheritance graph
[legend]
Collaboration diagram for Sawyer::CommandLine::ShowVersion:
Collaboration graph
[legend]

Public Types

typedef SharedPointer< ShowVersionPtr
 Reference counting pointer for this class.
 
- Public Types inherited from Sawyer::CommandLine::SwitchAction
typedef SharedPointer< SwitchActionPtr
 Reference counting pointer for this class.
 

Static Public Member Functions

static Ptr instance (const std::string &versionString)
 Allocating constructor.
 

Protected Member Functions

 ShowVersion (const std::string &versionString)
 Constructor for derived classes.
 
virtual void operator() (const ParserResult &)
 

Additional Inherited Members

- Public Member Functions inherited from Sawyer::CommandLine::SwitchAction
void run (const ParserResult &parserResult)
 Runs the action.
 
- Public Member Functions inherited from Sawyer::SharedObject
 SharedObject ()
 Default constructor.
 
 SharedObject (const SharedObject &)
 Copy constructor.
 
virtual ~SharedObject ()
 Virtual destructor.
 
SharedObjectoperator= (const SharedObject &)
 Assignment.
 

Member Typedef Documentation

◆ Ptr

Reference counting pointer for this class.

Definition at line 1626 of file Sawyer/CommandLine.h.

Constructor & Destructor Documentation

◆ ShowVersion()

Sawyer::CommandLine::ShowVersion::ShowVersion ( const std::string &  versionString)
explicitprotected

Constructor for derived classes.

Non-subclass users should use instance instead.

Member Function Documentation

◆ instance()

static Ptr Sawyer::CommandLine::ShowVersion::instance ( const std::string &  versionString)
static

Allocating constructor.

Returns a pointer to a new ShowVersion object. Uses will most likely want to use the showVersion factory instead, which requires less typing.

See also
Command line action factories, and the SwitchAction class.

◆ operator()()

virtual void Sawyer::CommandLine::ShowVersion::operator() ( const ParserResult )
protectedvirtual

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