QuitCommand Class Reference

Back to the index.

Public Member Functions | Static Public Member Functions | List of all members
QuitCommand Class Reference

A Command which quits the GXemul application. More...

#include <QuitCommand.h>

Inheritance diagram for QuitCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 QuitCommand ()
 Constructs a QuitCommand. More...
 
virtual ~QuitCommand ()
 
virtual bool Execute (GXemul &gxemul, const vector< string > &arguments)
 Executes the command on a given GXemul instance. More...
 
virtual string GetShortDescription () const
 Returns a short (one-line) description of the command. More...
 
virtual string GetLongDescription () const
 Returns a long description/help message for the command. More...
 
- Public Member Functions inherited from Command
 Command (const string &name, const string &argumentFormat)
 Constructs a Command. More...
 
virtual ~Command ()=0
 
const string & GetCommandName () const
 Gets the name of the command. More...
 
const string & GetArgumentFormat () const
 Gets the argument format for the command. More...
 
virtual bool MayBeReexecutedWithoutArgs () const
 Returns whether the command can be quickly re-executed using an empty command line. More...
 
- Public Member Functions inherited from ReferenceCountable
 ReferenceCountable ()
 Default constructor, which initializes the reference count to zero. More...
 
 ~ReferenceCountable ()
 

Static Public Member Functions

static void RunUnitTests (int &nSucceeded, int &nFailures)
 
- Static Public Member Functions inherited from Command
static void RunUnitTests (int &nSucceeded, int &nFailures)
 
- Static Public Member Functions inherited from UnitTestable
static void RunUnitTests (int &nSucceeded, int &nFailures)
 Runs unit test cases. More...
 

Detailed Description

A Command which quits the GXemul application.

Definition at line 40 of file QuitCommand.h.

Constructor & Destructor Documentation

◆ QuitCommand()

QuitCommand::QuitCommand ( )

Constructs a QuitCommand.

Definition at line 32 of file QuitCommand.cc.

Referenced by GetLongDescription().

◆ ~QuitCommand()

QuitCommand::~QuitCommand ( )
virtual

Definition at line 38 of file QuitCommand.cc.

Member Function Documentation

◆ Execute()

bool QuitCommand::Execute ( GXemul gxemul,
const vector< string > &  arguments 
)
virtual

Executes the command on a given GXemul instance.

Parameters
gxemulA reference to the GXemul instance.
argumentsA vector of zero or more string arguments.
Returns
true if the command succeeded, false if it failed.

Implements Command.

Definition at line 43 of file QuitCommand.cc.

References GXemul::GetUI(), GXemul::Quitting, GXemul::SetRunState(), and UI::Shutdown().

◆ GetLongDescription()

string QuitCommand::GetLongDescription ( ) const
virtual

Returns a long description/help message for the command.

Returns
A long description/help message for the command.

Implements Command.

Definition at line 57 of file QuitCommand.cc.

References UnitTest::Assert(), Command::Execute(), GXemul::GetRunState(), GXemul::Paused, QuitCommand(), GXemul::Quitting, UNITTEST, and UNITTESTS.

◆ GetShortDescription()

string QuitCommand::GetShortDescription ( ) const
virtual

Returns a short (one-line) description of the command.

Returns
A short description of the command.

Implements Command.

Definition at line 51 of file QuitCommand.cc.

◆ RunUnitTests()

static void QuitCommand::RunUnitTests ( int &  nSucceeded,
int &  nFailures 
)
static

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

Generated on Sun Sep 30 2018 16:05:18 for GXemul by doxygen 1.8.13