tclap 1.6.0
Public Member Functions | Protected Attributes | List of all members
TCLAP::VersionVisitor Class Reference

A Visitor that will call the version method of the given CmdLineOutput for the specified CmdLine object and then exit. More...

#include <VersionVisitor.h>

Inheritance diagram for TCLAP::VersionVisitor:
Inheritance graph
[legend]
Collaboration diagram for TCLAP::VersionVisitor:
Collaboration graph
[legend]

Public Member Functions

 VersionVisitor (const VersionVisitor &rhs)=delete
 Prevent accidental copying.
 
VersionVisitor & operator= (const VersionVisitor &rhs)=delete
 
 VersionVisitor (CmdLineInterface *cmd, CmdLineOutput **out)
 Constructor.
 
void visit () override
 Calls the version method of the output object using the specified CmdLine.
 
- Public Member Functions inherited from TCLAP::Visitor
 Visitor ()=default
 Constructor.
 
virtual ~Visitor ()=default
 Destructor.
 

Protected Attributes

CmdLineInterface * _cmd
 The CmdLine of interest.
 
CmdLineOutput ** _out
 The output object.
 

Detailed Description

A Visitor that will call the version method of the given CmdLineOutput for the specified CmdLine object and then exit.

Definition at line 36 of file VersionVisitor.h.

Constructor & Destructor Documentation

◆ VersionVisitor() [1/2]

TCLAP::VersionVisitor::VersionVisitor ( const VersionVisitor &  rhs)
delete

Prevent accidental copying.

◆ VersionVisitor() [2/2]

TCLAP::VersionVisitor::VersionVisitor ( CmdLineInterface *  cmd,
CmdLineOutput **  out 
)
inline

Constructor.

Parameters
cmd- The CmdLine the output is generated for.
out- The type of output.

Definition at line 61 of file VersionVisitor.h.

Member Function Documentation

◆ operator=()

VersionVisitor & TCLAP::VersionVisitor::operator= ( const VersionVisitor &  rhs)
delete

◆ visit()

void TCLAP::VersionVisitor::visit ( )
inlineoverridevirtual

Calls the version method of the output object using the specified CmdLine.

Implements TCLAP::Visitor.

Definition at line 68 of file VersionVisitor.h.

References _cmd.

Member Data Documentation

◆ _cmd

CmdLineInterface* TCLAP::VersionVisitor::_cmd
protected

The CmdLine of interest.

Definition at line 48 of file VersionVisitor.h.

Referenced by visit().

◆ _out

CmdLineOutput** TCLAP::VersionVisitor::_out
protected

The output object.

Definition at line 53 of file VersionVisitor.h.


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