Class containing the interactive CLI. More...

Public Member Functions
	InteractiveCLI (QCoreApplication *app)
	Constuct a new instance of InteractiveCLI. More...

void	unusedArgs (const std::vector< std::string > &args, int numUsed) const
	Print a warning to the user detailing extra arguments that they provided. More...

void	missingArg (const std::string &argName) const
	Print a warning about missing args to the specified command. More...

void	malformedArg (const std::string &argName, const std::string &val, const std::string &type) const
	Print a warning about a malformed argument. More...

void	start ()
	Start taking in commands. More...

HulaCliStatus	processCommand (const std::string &command, const std::vector< std::string > &args)
	Proccess the command entered by the user. More...

TransportState	getState ()
	Fetch the state of the internal Transport. More...

void	setOutputFilePath (const std::string &path)
	Set the default output file path used by the CLI. More...

	~InteractiveCLI ()
	Destructor for InteractiveCLI.

Detailed Description

Class containing the interactive CLI.

Constructor & Destructor Documentation

InteractiveCLI::InteractiveCLI ( QCoreApplication * app )

Constuct a new instance of InteractiveCLI.

This will not start the command loop.

TransportState InteractiveCLI::getState ( )

Fetch the state of the internal Transport.

void InteractiveCLI::malformedArg	(	const std::string &	argName,
		const std::string &	val,
		const std::string &	type
	)		const

Print a warning about a malformed argument.

Parameters

argName	Name of the malformed argument
val	Value given by user
type	Expected type of value

void InteractiveCLI::missingArg ( const std::string & argName ) const

Print a warning about missing args to the specified command.

Parameters

argName Name of the missing argument

HulaCliStatus InteractiveCLI::processCommand	(	const std::string &	command,
		const std::vector< std::string > &	args
	)

Proccess the command entered by the user.

Parameters

command	Name of command in short or long form
args	Vector of arguments that should be used with the command

void InteractiveCLI::setOutputFilePath ( const std::string & path )

Set the default output file path used by the CLI.

This is used primarily so that the CLI –ouput-file flag can affect the export path.

void InteractiveCLI::start ( )

Start taking in commands.

This is an infinite loop.

void InteractiveCLI::unusedArgs	(	const std::vector< std::string > &	args,
		int	numUsed
	)		const

Print a warning to the user detailing extra arguments that they provided.

Parameters

args	Vector of all arguments provided to the command
numUsed	Number of arguments actually used by the command

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