Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members

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:

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

Collaboration graph
[legend]
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 56 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 63 of file HelpVisitor.h.


Member Data Documentation

CmdLineInterface* TCLAP::HelpVisitor::_cmd [protected]
 

The CmdLine the output will be generated for.

Definition at line 42 of file HelpVisitor.h.

CmdLineOutput** TCLAP::HelpVisitor::_out [protected]
 

The output object.

Definition at line 47 of file HelpVisitor.h.


The documentation for this class was generated from the following file:
Generated on Mon Sep 28 11:32:18 2009 for tclap by  doxygen 1.3.9.1