AddComponentCommand Class Reference

Back to the index.

Public Member Functions | List of all members
AddComponentCommand Class Reference

A Command which adds a Component to some place in a GXemul instance' component tree. More...

#include <AddComponentCommand.h>

Inheritance diagram for AddComponentCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 AddComponentCommand ()
 Constructs an AddComponentCommand. More...
 
virtual ~AddComponentCommand ()
 
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 adds a Component to some place in a GXemul instance' component tree.

Definition at line 41 of file AddComponentCommand.h.

Constructor & Destructor Documentation

◆ AddComponentCommand()

AddComponentCommand::AddComponentCommand ( )

Constructs an AddComponentCommand.

Definition at line 33 of file AddComponentCommand.cc.

◆ ~AddComponentCommand()

AddComponentCommand::~AddComponentCommand ( )
virtual

Definition at line 39 of file AddComponentCommand.cc.

Member Function Documentation

◆ Execute()

bool AddComponentCommand::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 50 of file AddComponentCommand.cc.

◆ GetLongDescription()

string AddComponentCommand::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 110 of file AddComponentCommand.cc.

◆ GetShortDescription()

string AddComponentCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 104 of file AddComponentCommand.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