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

PLearn::HelpCommand Class Reference

#include <HelpCommand.h>

Inheritance diagram for PLearn::HelpCommand:

Inheritance graph
[legend]
Collaboration diagram for PLearn::HelpCommand:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 HelpCommand ()
virtual void run (const vector< string > &args)
 The actual implementation of the 'HelpCommand' command.


Protected Member Functions

void helpOverview ()
void helpAboutScript (const string &fname)
void helpScripts ()
void helpCommands ()
void helpDatasets ()
void helpObject (const string &objectname="")

Static Protected Attributes

PLearnCommandRegistry reg_
 This allows to register the 'HelpCommand' command in the command registry.


Constructor & Destructor Documentation

PLearn::HelpCommand::HelpCommand  )  [inline]
 

Definition at line 61 of file HelpCommand.h.


Member Function Documentation

void PLearn::HelpCommand::helpAboutScript const string fname  )  [protected]
 

Definition at line 116 of file HelpCommand.cc.

References PLearn::endl(), PLearn::file_exists(), fname, and PLERROR.

Referenced by run().

void PLearn::HelpCommand::helpCommands  )  [protected]
 

Definition at line 97 of file HelpCommand.cc.

References PLearn::endl(), and PLearn::prgname().

Referenced by run().

void PLearn::HelpCommand::helpDatasets  )  [protected]
 

Definition at line 111 of file HelpCommand.cc.

References PLearn::endl(), and PLearn::getDataSetHelp().

Referenced by run().

void PLearn::HelpCommand::helpObject const string objectname = ""  )  [protected]
 

void PLearn::HelpCommand::helpOverview  )  [protected]
 

Definition at line 51 of file HelpCommand.cc.

References PLearn::endl(), and PLearn::prgname().

Referenced by run().

void PLearn::HelpCommand::helpScripts  )  [protected]
 

Definition at line 64 of file HelpCommand.cc.

References PLearn::endl(), and PLearn::prgname().

Referenced by run().

void PLearn::HelpCommand::run const vector< string > &  args  )  [virtual]
 

The actual implementation of the 'HelpCommand' command.

Implements PLearn::PLearnCommand.

Definition at line 126 of file HelpCommand.cc.

References PLearn::displayObjectHelp(), PLearn::extract_extension(), helpAboutScript(), helpCommands(), helpDatasets(), helpOverview(), and helpScripts().


Member Data Documentation

PLearnCommandRegistry PLearn::HelpCommand::reg_ [static, protected]
 

This allows to register the 'HelpCommand' command in the command registry.


The documentation for this class was generated from the following files:
Generated on Tue Aug 17 16:28:02 2004 for PLearn by doxygen 1.3.7