Help.h 1.16 KB
Newer Older
gsell's avatar
gsell committed
1
//
2 3 4 5 6
// Class Help
//   The class for OPAL HELP command.
//
// Copyright (c) 2000 - 2021, Paul Scherrer Institut, Villigen PSI, Switzerland
// All rights reserved
gsell's avatar
gsell committed
7
//
8
// This file is part of OPAL.
gsell's avatar
gsell committed
9
//
10 11 12 13
// OPAL is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
gsell's avatar
gsell committed
14
//
15 16 17 18 19
// You should have received a copy of the GNU General Public License
// along with OPAL. If not, see <https://www.gnu.org/licenses/>.
//
#ifndef OPAL_Help_HH
#define OPAL_Help_HH
gsell's avatar
gsell committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33

#include "AbstractObjects/Action.h"


class Help: public Action {

public:

    /// Exemplar constructor.
    Help();

    virtual ~Help();

    /// Make clone.
34
    virtual Help* clone(const std::string& name);
gsell's avatar
gsell committed
35 36 37 38 39

    /// Execute the command.
    virtual void execute();

    /// Parse command (special for one-attribute command).
40
    virtual void parse(Statement&);
gsell's avatar
gsell committed
41 42 43 44

private:

    // Not implemented.
45 46
    Help(const Help&);
    void operator=(const Help&);
gsell's avatar
gsell committed
47 48

    // Clone constructor.
49
    Help(const std::string& name, Help* parent);
gsell's avatar
gsell committed
50 51 52
};

#endif // OPAL_Help_HH