uuid::console::Commands::AvailableCommands Class Reference

Available commands in the shell's context with the current flags. More...

#include <uuid/console.h>

Collaboration diagram for uuid::console::Commands::AvailableCommands:

Classes
class	const_iterator
	Iterator of available commands for execution on a Shell. More...

Public Types
using	command_iterator = std::multimap< unsigned int, Command >::const_iterator

Public Member Functions
	AvailableCommands (const Shell &shell, const command_iterator &begin, const command_iterator &end)
	Create an iterable object describing available commands in a shell with the current flags. More...
const_iterator	begin () const
	Returns an iterator to the first command. More...
const_iterator	cbegin () const
	Returns an iterator to the first command. More...
const_iterator	end () const
	Returns an iterator to the element following the last command. More...
const_iterator	cend () const
	Returns an iterator to the element following the last command. More...

Private Attributes
const Shell &	shell_
command_iterator	begin_
command_iterator	end_

Detailed Description

Available commands in the shell's context with the current flags.

Iterators are invalidated if the commands, context or flags for the shell change.

Since

0.9.0

Definition at line 210 of file console.h.

Member Typedef Documentation

command_iterator

using uuid::console::Commands::AvailableCommands::command_iterator = std::multimap<unsigned int,Command>::const_iterator

Type of the underlying command iterator.

Since

0.9.0

Definition at line 212 of file console.h.

Constructor & Destructor Documentation

AvailableCommands()

uuid::console::Commands::AvailableCommands::AvailableCommands	(	const Shell &	shell,
		const command_iterator &	begin,
		const command_iterator &	end
	)

Create an iterable object describing available commands in a shell with the current flags.

Iterators are invalidated if the commands, context or flags for the shell change.

Parameters

[in]	shell	Shell that is accessing commands.
[in]	begin	Beginning of command iterators.
[in]	end	End of command iterators.

Since

0.9.0

Definition at line 45 of file commands_iterable.cpp.

Member Function Documentation

begin()

const_iterator uuid::console::Commands::AvailableCommands::begin ( ) const

inline

Returns an iterator to the first command.

Since

0.9.0

Definition at line 351 of file console.h.

cbegin()

Commands::AvailableCommands::const_iterator uuid::console::Commands::AvailableCommands::cbegin

(

)

const

Returns an iterator to the first command.

Since

0.9.0

Definition at line 54 of file commands_iterable.cpp.

cend()

Commands::AvailableCommands::const_iterator uuid::console::Commands::AvailableCommands::cend

(

)

const

Returns an iterator to the element following the last command.

Since

0.9.0

Definition at line 58 of file commands_iterable.cpp.

end()

const_iterator uuid::console::Commands::AvailableCommands::end ( ) const

inline

Returns an iterator to the element following the last command.

Since

0.9.0

Definition at line 363 of file console.h.

Member Data Documentation

begin_

command_iterator uuid::console::Commands::AvailableCommands::begin_

private

Beginning of command iterators.

Since

0.9.0

Definition at line 373 of file console.h.

end_

command_iterator uuid::console::Commands::AvailableCommands::end_

private

End of command iterators.

Since

0.9.0

Definition at line 374 of file console.h.

shell_

const Shell& uuid::console::Commands::AvailableCommands::shell_

private

Shell that is accessing commands.

Since

0.9.0

Definition at line 372 of file console.h.

---

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

• mcu-uuid-console/src/uuid/console.h
• mcu-uuid-console/src/commands_iterable.cpp