StatusCommand Class Reference

Back to the index.

Public Member Functions | List of all members
StatusCommand Class Reference

A Command which prints the current status. More...

#include <StatusCommand.h>

Inheritance diagram for StatusCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 StatusCommand ()
 Constructs a StatusCommand. More...
 
virtual ~StatusCommand ()
 
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 ()
 

Additional Inherited Members

- 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 prints the current status.

The status includes the RunState (Running or Paused).

Definition at line 42 of file StatusCommand.h.

Constructor & Destructor Documentation

◆ StatusCommand()

StatusCommand::StatusCommand ( )

Constructs a StatusCommand.

Definition at line 32 of file StatusCommand.cc.

◆ ~StatusCommand()

StatusCommand::~StatusCommand ( )
virtual

Definition at line 38 of file StatusCommand.cc.

Member Function Documentation

◆ Execute()

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

References GXemul::GetRunStateAsString(), GXemul::GetStep(), GXemul::GetUI(), and UI::ShowDebugMessage().

◆ GetLongDescription()

string StatusCommand::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 62 of file StatusCommand.cc.

◆ GetShortDescription()

string StatusCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 56 of file StatusCommand.cc.


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

Generated on Tue Aug 25 2020 19:25:06 for GXemul by doxygen 1.8.18