OPAL (Object Oriented Parallel Accelerator Library)  2021.1.99
OPAL
Help.h
Go to the documentation of this file.
1 //
2 // Class Help
3 // The class for OPAL HELP command.
4 //
5 // Copyright (c) 2000 - 2021, Paul Scherrer Institut, Villigen PSI, Switzerland
6 // All rights reserved
7 //
8 // This file is part of OPAL.
9 //
10 // OPAL is free software: you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation, either version 3 of the License, or
13 // (at your option) any later version.
14 //
15 // You should have received a copy of the GNU General Public License
16 // along with OPAL. If not, see <https://www.gnu.org/licenses/>.
17 //
18 #ifndef OPAL_Help_HH
19 #define OPAL_Help_HH
20 
21 #include "AbstractObjects/Action.h"
22 
23 
24 class Help: public Action {
25 
26 public:
27 
29  Help();
30 
31  virtual ~Help();
32 
34  virtual Help* clone(const std::string& name);
35 
37  virtual void execute();
38 
40  virtual void parse(Statement&);
41 
42 private:
43 
44  // Not implemented.
45  Help(const Help&);
46  void operator=(const Help&);
47 
48  // Clone constructor.
49  Help(const std::string& name, Help* parent);
50 };
51 
52 #endif // OPAL_Help_HH
const std::string name
The base class for all OPAL actions.
Definition: Action.h:30
Definition: Help.h:24
virtual ~Help()
Definition: Help.cpp:44
virtual Help * clone(const std::string &name)
Make clone.
Definition: Help.cpp:48
void operator=(const Help &)
virtual void execute()
Execute the command.
Definition: Help.cpp:53
virtual void parse(Statement &)
Parse command (special for one-attribute command).
Definition: Help.cpp:69
Help(const Help &)
Help()
Exemplar constructor.
Definition: Help.cpp:28
Interface for statements.
Definition: Statement.h:38