SaveCommand Class Reference

Back to the index.

Public Member Functions | List of all members
SaveCommand Class Reference

A Command which saves a Component tree to a file in the filesystem. More...

#include <SaveCommand.h>

Inheritance diagram for SaveCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 SaveCommand ()
 Constructs an SaveCommand. More...
 
virtual ~SaveCommand ()
 
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 saves a Component tree to a file in the filesystem.

Definition at line 40 of file SaveCommand.h.

Constructor & Destructor Documentation

◆ SaveCommand()

SaveCommand::SaveCommand ( )

Constructs an SaveCommand.

Definition at line 34 of file SaveCommand.cc.

◆ ~SaveCommand()

SaveCommand::~SaveCommand ( )
virtual

Definition at line 40 of file SaveCommand.cc.

Member Function Documentation

◆ Execute()

bool SaveCommand::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 51 of file SaveCommand.cc.

References GXemul::GetEmulationFilename().

◆ GetLongDescription()

string SaveCommand::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 136 of file SaveCommand.cc.

◆ GetShortDescription()

string SaveCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 130 of file SaveCommand.cc.


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

Generated on Tue Mar 24 2020 14:04:48 for GXemul by doxygen 1.8.17