TCLAP::HelpVisitor Class Reference

A Visitor object that calls the usage method of the given CmdLineOutput object for the specified CmdLine object. More...

#include <HelpVisitor.h>

Inheritance diagram for TCLAP::HelpVisitor:
TCLAP::Visitor

List of all members.

Public Member Functions

 HelpVisitor (CmdLineInterface *cmd, CmdLineOutput **out)
 Constructor.
void visit ()
 Calls the usage method of the CmdLineOutput for the specified CmdLine.

Protected Attributes

CmdLineInterface_cmd
 The CmdLine the output will be generated for.
CmdLineOutput ** _out
 The output object.

Detailed Description

A Visitor object that calls the usage method of the given CmdLineOutput object for the specified CmdLine object.

Definition at line 35 of file HelpVisitor.h.


Constructor & Destructor Documentation

TCLAP::HelpVisitor::HelpVisitor ( CmdLineInterface cmd,
CmdLineOutput **  out 
) [inline]

Constructor.

Parameters:
cmd - The CmdLine the output will be generated for.
out - The type of output.

Definition at line 63 of file HelpVisitor.h.


Member Function Documentation

void TCLAP::HelpVisitor::visit (  )  [inline, virtual]

Calls the usage method of the CmdLineOutput for the specified CmdLine.

Reimplemented from TCLAP::Visitor.

Definition at line 70 of file HelpVisitor.h.

References _cmd.


Member Data Documentation

The CmdLine the output will be generated for.

Definition at line 49 of file HelpVisitor.h.

Referenced by visit().

The output object.

Definition at line 54 of file HelpVisitor.h.


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

Generated on Sat Apr 16 15:34:25 2011 for tclap by  doxygen 1.6.0