ViewerHelp Class Reference
[IPSRV remote instructions, libipsaViewer classes]

Instruction subclass which returns a list of all available IPSRV commands. More...

#include <ViewerHelp.h>

Inheritance diagram for ViewerHelp:

[legend]

Collaboration diagram for ViewerHelp:

[legend]

List of all members.

Public Member Functions
	ViewerHelp (std::map< std::string, Instruction * > AllInstructions, const std::string &code=std::string("help"))
Protected Member Functions
virtual tExecResultType	vExecute (std::vector< std::string > &Instr, std::ostringstream &answer, unsigned int &numberOfReturnValues)
Protected Attributes
const std::map< std::string, Instruction * >	lAllInstructions

---

Detailed Description

Instruction subclass which returns a list of all available IPSRV commands.

Definition at line 41 of file ViewerHelp.h.

---

Constructor & Destructor Documentation

ViewerHelp::ViewerHelp	(	std::map< std::string, Instruction * >	AllInstructions,
		const std::string &	code = std::string("help")
	)			[inline]

Definition at line 44 of file ViewerHelp.h.

---

Member Function Documentation

Instruction::tExecResultType ViewerHelp::vExecute	(	std::vector< std::string > &	Instr,
		std::ostringstream &	answer,
		unsigned int &	numberOfReturnValues
	)			[protected, virtual]

Virtual method which must be overridden by any subclass. It does the "real" execution of the command and is called by Instruction::findAndExecute().

Parameters:

	Instr	instruction vector which is build like Instruction::instrdata of the specific subclass of Instruction
	answer	a stringstream where the answer of Instruction::vExecute() gets written to
	numberOfReturnValues	tells the method how many values should be stored in answer.

Returns:

a value from the enum Instruction::tExecResultType

Reimplemented from Instruction.

Definition at line 29 of file ViewerHelp.cpp.

References Instruction::eOK, Instruction::getCmdHelpString(), and lAllInstructions.

---

Member Data Documentation

const std::map<std::string, Instruction*> ViewerHelp::lAllInstructions [protected]

Definition at line 48 of file ViewerHelp.h.

Referenced by vExecute().

---

The documentation for this class was generated from the following files:

• include/IPSA/viewer/instructions/ViewerHelp.h
• source/viewer/instructions/ViewerHelp.cpp