include/IPSA/viewer/instructions/ViewerHelp.h

Go to the documentation of this file.

#ifndef _INSTRUCTIONS_VIEWER_HELP_H_
#define _INSTRUCTIONS_VIEWER_HELP_H_
/*
 *  ViewerHelp.h
 *
 * Copyright (c) 2007, 2008, 2009, University of Karlsruhe (for members see AUTHORS file)
 * Copyright (c) 2011, Karlsruhe Institute of Technology (for members see AUTHORS file)
 *
 * ISC License
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 *
 *  Created by Alexander Bierbaum
 */

#include "../../IPSA.h"
#include "Instruction.h"
#include <map>
#include <vector>
#include <string>

class IPSA_VIEWER_IMPORT_EXPORT ViewerHelp : public Instruction
{
public:
        ViewerHelp(std::map<std::string, Instruction*> AllInstructions, const std::string& code = std::string("help"))
        :Instruction(code), lAllInstructions(AllInstructions) {;}
protected:
        virtual tExecResultType vExecute(std::vector<std::string>& Instr, std::ostringstream& answer, unsigned int& numberOfReturnValues);
        const std::map<std::string, Instruction*> lAllInstructions;
};

#endif // _INSTRUCTIONS_VIEWER_HELP_H_

---