ICommand Struct Referenceabstract

Base abstract struct for commandsA command is an object that encapsulates all necessary information to perform an action later one. Typically, a command implementation should contain an implementation of CommandInterface interface, and a list of properties. More...

Inheritance diagram for ICommand:
InitCommand LoadKernelCommand LoadScenarioCommand ResetCommand RunScenarioCommand SetupScenarioCommand

Public Member Functions

virtual PlayerReturnCode execute (KernelFacade &kernelFacade) const =0
 Execute the command. More...
 

Detailed Description

Base abstract struct for commands

A command is an object that encapsulates all necessary information to perform an action later one. Typically, a command implementation should contain an implementation of CommandInterface interface, and a list of properties.

Author
cgarraud (INRIA)
Date
2016-01-26

Member Function Documentation

virtual PlayerReturnCode execute ( KernelFacade kernelFacade) const
pure virtual

Execute the command.

Parameters
[in]kernelFacadethe kernel facade that gives access to kernel features

Implemented in SetupScenarioCommand, RunScenarioCommand, ResetCommand, LoadScenarioCommand, LoadKernelCommand, and InitCommand.