SVCS - English Documentation
Loading...
Searching...
No Matches
svcs::test::cli::utils::VersionCommand Class Reference

Command for displaying version information about SVCS. More...

#include <VersionCommand.hxx>

Inheritance diagram for svcs::test::cli::utils::VersionCommand:
svcs::cli::ICommand

Public Member Functions

 VersionCommand (std::shared_ptr< ISubject > subject)
 Constructs the VersionCommand.
bool execute (const std::vector< std::string > &args) override
 Executes the version command.
std::string getName () const override
 Gets the name of the command.
std::string getDescription () const override
 Gets the description of the command.
std::string getUsage () const override
 Gets the usage syntax of the command.
void showHelp () const override
 Shows detailed help information for this command.
Public Member Functions inherited from svcs::cli::ICommand
virtual ~ICommand ()=default
 Virtual destructor.

Detailed Description

Command for displaying version information about SVCS.

The VersionCommand shows the current version, build information, and copyright details.

Constructor & Destructor Documentation

◆ VersionCommand()

svcs::cli::VersionCommand::VersionCommand ( std::shared_ptr< ISubject > subject)
explicit

Constructs the VersionCommand.

Parameters
subjectShared pointer to the event bus for notifications.

Member Function Documentation

◆ execute()

bool svcs::cli::VersionCommand::execute ( const std::vector< std::string > & args)
overridevirtual

Executes the version command.

Parameters
argsCommand arguments (ignored for version command).
Returns
true always, as version command cannot fail.

Implements svcs::cli::ICommand.

◆ getDescription()

std::string svcs::cli::VersionCommand::getDescription ( ) const
nodiscardoverridevirtual

Gets the description of the command.

Returns
"Show version information"

Implements svcs::cli::ICommand.

◆ getName()

std::string svcs::cli::VersionCommand::getName ( ) const
inlinenodiscardoverridevirtual

Gets the name of the command.

Returns
"version"

Implements svcs::cli::ICommand.

◆ getUsage()

std::string svcs::cli::VersionCommand::getUsage ( ) const
nodiscardoverridevirtual

Gets the usage syntax of the command.

Returns
"svcs version"

Implements svcs::cli::ICommand.

◆ showHelp()

void svcs::cli::VersionCommand::showHelp ( ) const
overridevirtual

Shows detailed help information for this command.

Implements svcs::cli::ICommand.


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