ListComponentsCommand Class Reference

Back to the index.

Public Member Functions | List of all members
ListComponentsCommand Class Reference

A Command which lists all available components. More...

#include <ListComponentsCommand.h>

Inheritance diagram for ListComponentsCommand:
Command ReferenceCountable UnitTestable

Public Member Functions

 ListComponentsCommand ()
 Constructs a ListComponentsCommand. More...
 
virtual ~ListComponentsCommand ()
 
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 lists all available components.

Definition at line 40 of file ListComponentsCommand.h.

Constructor & Destructor Documentation

◆ ListComponentsCommand()

ListComponentsCommand::ListComponentsCommand ( )

Constructs a ListComponentsCommand.

Definition at line 33 of file ListComponentsCommand.cc.

◆ ~ListComponentsCommand()

ListComponentsCommand::~ListComponentsCommand ( )
virtual

Definition at line 39 of file ListComponentsCommand.cc.

Member Function Documentation

◆ Execute()

bool ListComponentsCommand::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 44 of file ListComponentsCommand.cc.

References ComponentFactory::CreateComponent(), ComponentFactory::GetAllComponentNames(), ComponentFactory::GetAttribute(), GXemul::GetUI(), refcount_ptr< T >::IsNULL(), and UI::ShowDebugMessage().

◆ GetLongDescription()

string ListComponentsCommand::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 84 of file ListComponentsCommand.cc.

◆ GetShortDescription()

string ListComponentsCommand::GetShortDescription ( ) const
virtual

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

Returns
A short description of the command.

Implements Command.

Definition at line 78 of file ListComponentsCommand.cc.


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