LoadCommand Class Reference

Back to the index.

Public Member Functions | List of all members
LoadCommand Class Reference

A Command which loads a Component tree from a file in the filesystem. More...

#include <LoadCommand.h>

Inheritance diagram for LoadCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 LoadCommand ()
 Constructs an LoadCommand. More...
 
virtual ~LoadCommand ()
 
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 loads a Component tree from a file in the filesystem.

Definition at line 41 of file LoadCommand.h.

Constructor & Destructor Documentation

◆ LoadCommand()

LoadCommand::LoadCommand ( )

Constructs an LoadCommand.

Definition at line 37 of file LoadCommand.cc.

◆ ~LoadCommand()

LoadCommand::~LoadCommand ( )
virtual

Definition at line 43 of file LoadCommand.cc.

Member Function Documentation

◆ Execute()

bool LoadCommand::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 145 of file LoadCommand.cc.

References GXemul::GetEmulationFilename().

◆ GetLongDescription()

string LoadCommand::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 229 of file LoadCommand.cc.

◆ GetShortDescription()

string LoadCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 223 of file LoadCommand.cc.


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