MoveComponentCommand Class Reference

Back to the index.

Public Member Functions | Static Public Member Functions | List of all members
MoveComponentCommand Class Reference

A Command which moves a Component from one location to another in the component tree. More...

#include <MoveComponentCommand.h>

Inheritance diagram for MoveComponentCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

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

Static Public Member Functions

static void RunUnitTests (int &nSucceeded, int &nFailures)
 
- 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 moves a Component from one location to another in the component tree.

Definition at line 41 of file MoveComponentCommand.h.

Constructor & Destructor Documentation

◆ MoveComponentCommand()

MoveComponentCommand::MoveComponentCommand ( )

Constructs a MoveComponentCommand.

Definition at line 32 of file MoveComponentCommand.cc.

◆ ~MoveComponentCommand()

MoveComponentCommand::~MoveComponentCommand ( )
virtual

Definition at line 38 of file MoveComponentCommand.cc.

Member Function Documentation

◆ Execute()

bool MoveComponentCommand::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 49 of file MoveComponentCommand.cc.

◆ GetLongDescription()

string MoveComponentCommand::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 119 of file MoveComponentCommand.cc.

References UnitTest::Assert(), Component::GetChildren(), GXemul::GetCommandInterpreter(), GXemul::GetRootComponent(), CommandInterpreter::RunCommand(), UNITTEST, and UNITTESTS.

◆ GetShortDescription()

string MoveComponentCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 113 of file MoveComponentCommand.cc.

◆ RunUnitTests()

static void MoveComponentCommand::RunUnitTests ( int &  nSucceeded,
int &  nFailures 
)
static

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

Generated on Fri Dec 7 2018 19:52:23 for GXemul by doxygen 1.8.13