PLearnCommand.h

Go to the documentation of this file.

// -*- C++ -*-4 1999/10/29 20:41:34 dugas

// PLearnCommand.h
// Copyright (C) 2002 Pascal Vincent
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
// 
//  1. Redistributions of source code must retain the above copyright
//     notice, this list of conditions and the following disclaimer.
// 
//  2. Redistributions in binary form must reproduce the above copyright
//     notice, this list of conditions and the following disclaimer in the
//     documentation and/or other materials provided with the distribution.
// 
//  3. The name of the authors may not be used to endorse or promote
//     products derived from this software without specific prior written
//     permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE AUTHORS ``AS IS'' AND ANY EXPRESS OR
// IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
// OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
// NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
// TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
// LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
// NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// This file is part of the PLearn library. For more information on the PLearn
// library, go to the PLearn Web site at www.plearn.org


/* *******************************************************      
   * $Id: PLearnCommand.h,v 1.2 2004/02/20 21:11:40 chrish42 Exp $
   * This file is part of the PLearn library.
   ******************************************************* */


#ifndef PLearnCommand_INC
#define PLearnCommand_INC

#include <string>
#include <vector>

namespace PLearn {
using namespace std;



class PLearnCommand
{
public:
  string name;        // The name of the command
  string description; // A short one line description of what the command does
  string helpmsg; // A more detailed help of the command and its options

  PLearnCommand(const string& name_, const string& description_, const string& helpmsg_)
    : name(name_), description(description_), helpmsg(helpmsg_) 
  {}

  virtual void run(const vector<string>& args) = 0;

  virtual ~PLearnCommand() {}
};


} // end of namespace PLearn

#endif

---