ResetCommand Class Reference

Back to the index.

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

A Command which resets the current emulation. More...

#include <ResetCommand.h>

Inheritance diagram for ResetCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 ResetCommand ()
 Constructs a ResetCommand. More...
 
virtual ~ResetCommand ()
 
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 resets the current emulation.

The emulation is reset by resetting all components' state variables to their initial state, and by changing the current RunState to Paused.

Definition at line 43 of file ResetCommand.h.

Constructor & Destructor Documentation

◆ ResetCommand()

ResetCommand::ResetCommand ( )

Constructs a ResetCommand.

Definition at line 32 of file ResetCommand.cc.

Referenced by GetLongDescription().

◆ ~ResetCommand()

ResetCommand::~ResetCommand ( )
virtual

Definition at line 38 of file ResetCommand.cc.

Member Function Documentation

◆ Execute()

bool ResetCommand::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 ResetCommand.cc.

References GXemul::Paused, GXemul::Reset(), and GXemul::SetRunState().

◆ GetLongDescription()

string ResetCommand::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 58 of file ResetCommand.cc.

References UnitTest::Assert(), Command::Execute(), GXemul::GetRunState(), GXemul::Paused, ResetCommand(), GXemul::Running, GXemul::SetRunState(), UNITTEST, and UNITTESTS.

◆ GetShortDescription()

string ResetCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 52 of file ResetCommand.cc.

◆ RunUnitTests()

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

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

Generated on Fri Dec 7 2018 19:52:23 for GXemul by doxygen 1.8.13