Represents an operation that can be performed based on the 'Context' (This is an abstract class, it cannot be directly instantiated) More...
#include <ContextOperation.h>
Public Member Functions | |
| virtual bool | IsPossible (const Context &context) const =0 |
| Indicates whether the operation can be performed given the current state of affairs. More... | |
| virtual std::string | getDescription () const =0 |
| Gives a short (infinitive verb) indication of what the operation does. More... | |
| virtual std::string | Perform (Context &context) const =0 |
| Performs the operation on the context. More... | |
Detailed Description
Represents an operation that can be performed based on the 'Context' (This is an abstract class, it cannot be directly instantiated)
Member Function Documentation
§ getDescription()
|
pure virtual |
Gives a short (infinitive verb) indication of what the operation does.
- Returns
- e.g. "use the context to do something"
Implemented in LoadHardCodedPointsOperation, LoadImagesOperation, RemoveAllImagesOperation, RemoveAllPointsOperation, DisplayImageDetailsOperation, EnterPointsOperation, and PurposelyBrokenOperation.
§ IsPossible()
|
pure virtual |
Indicates whether the operation can be performed given the current state of affairs.
- Parameters
-
context the context for which the operation may be runnable
- Returns
- true when the operation may be performed
Implemented in LoadHardCodedPointsOperation, LoadImagesOperation, RemoveAllImagesOperation, DisplayImageDetailsOperation, EnterPointsOperation, RemoveAllPointsOperation, and PurposelyBrokenOperation.
§ Perform()
|
pure virtual |
Performs the operation on the context.
- Parameters
-
context the context onto which to perform the operatoin
- Returns
- a string detailing the results of the operation
Implemented in LoadHardCodedPointsOperation, LoadImagesOperation, PurposelyBrokenOperation, RemoveAllImagesOperation, RemoveAllPointsOperation, DisplayImageDetailsOperation, and EnterPointsOperation.
The documentation for this class was generated from the following file:
- Context/Operations/ContextOperation.h
