StatusCommand.h Source File
Back to the index.
src
include
commands
StatusCommand.h
Go to the documentation of this file.
1
#ifndef STATUSCOMMAND_H
2
#define STATUSCOMMAND_H
3
4
/*
5
* Copyright (C) 2008-2010 Anders Gavare. All rights reserved.
6
*
7
* Redistribution and use in source and binary forms, with or without
8
* modification, are permitted provided that the following conditions are met:
9
*
10
* 1. Redistributions of source code must retain the above copyright
11
* notice, this list of conditions and the following disclaimer.
12
* 2. Redistributions in binary form must reproduce the above copyright
13
* notice, this list of conditions and the following disclaimer in the
14
* documentation and/or other materials provided with the distribution.
15
* 3. The name of the author may not be used to endorse or promote products
16
* derived from this software without specific prior written permission.
17
*
18
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21
* ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24
* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27
* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28
* SUCH DAMAGE.
29
*/
30
31
#include "
misc.h
"
32
33
#include "
Command.h
"
34
#include "
UnitTest.h
"
35
36
37
/**
38
* \brief A Command which prints the current status.
39
*
40
* The status includes the RunState (Running or Paused).
41
*/
42
class
StatusCommand
43
:
public
Command
44
{
45
public
:
46
/**
47
* \brief Constructs a %StatusCommand.
48
*/
49
StatusCommand
();
50
51
virtual
~StatusCommand
();
52
53
virtual
bool
Execute
(
GXemul
& gxemul,
const
vector<string>& arguments);
54
55
virtual
string
GetShortDescription
()
const
;
56
57
virtual
string
GetLongDescription
()
const
;
58
};
59
60
61
#endif // STATUSCOMMAND_H
StatusCommand::StatusCommand
StatusCommand()
Constructs a StatusCommand.
Definition:
StatusCommand.cc:32
GXemul
The main emulator class.
Definition:
GXemul.h:55
StatusCommand::Execute
virtual bool Execute(GXemul &gxemul, const vector< string > &arguments)
Executes the command on a given GXemul instance.
Definition:
StatusCommand.cc:43
Command.h
StatusCommand::GetShortDescription
virtual string GetShortDescription() const
Returns a short (one-line) description of the command.
Definition:
StatusCommand.cc:56
Command
A Command is a named function, executed by the CommandInterpreter.
Definition:
Command.h:51
StatusCommand
A Command which prints the current status.
Definition:
StatusCommand.h:44
misc.h
UnitTest.h
StatusCommand::~StatusCommand
virtual ~StatusCommand()
Definition:
StatusCommand.cc:38
StatusCommand::GetLongDescription
virtual string GetLongDescription() const
Returns a long description/help message for the command.
Definition:
StatusCommand.cc:62
Generated on Tue Aug 25 2020 19:25:06 for GXemul by
1.8.18