ChooseProjectCommand Class Reference

Class for the choose-project command. More...

#include <ChooseProjectCommand.hpp>

Inheritance diagram for ChooseProjectCommand:

Collaboration diagram for ChooseProjectCommand:

Public Member Functions
	ChooseProjectCommand ()
int	execute (std::vector< std::string > args)
	Executes the command. More...
Public Member Functions inherited from ToolCommand
std::string	GetCommandName ()
	Retrieves the name of the command. More...
std::string	GetSyntax ()
	Retrieves the syntax of the command. More...
std::string	GetDescription ()
	Retrieves the description of the command. More...

Additional Inherited Members
Protected Attributes inherited from ToolCommand
std::string	command = ""
	The name of the command. More...
std::string	syntax = ""
	The syntax of the command. This should include the command name, as well as any arguments. More...
std::string	description = ""
	A description of the command. More...

Detailed Description

Class for the choose-project command.

This command allows a project to be selected by ID. The ID is based on its index, which can be found by using the list-projects command. This is an alternative to using the set-project command.

Constructor & Destructor Documentation

ChooseProjectCommand()

ChooseProjectCommand::ChooseProjectCommand ( )

inline

Member Function Documentation

execute()

int ChooseProjectCommand::execute ( std::vector< std::string >  args )

inlinevirtual

Executes the command.

Parameters

args	- A list of arguments provided to the command.

Returns

The command execution result. Will return 0 if the command completed successfully. If an error occurred, this will usually return a negative number.

Reimplemented from ToolCommand.

---

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

• HEKTool/components/console/commands/ChooseProjectCommand.hpp