This test scenario takes a given set of rules and a given set of error graphs and performs a single backward step, including rule preparation.
More...
#include <BackwardStepTest.h>
|
virtual void | initialize (unordered_map< string, string > ¶meters) override |
| Initializes the scenario with the given mapping, where the keys are parameter names. More...
|
|
void | addParameter (string paramName, string description, bool mandatory=true) |
| Defined a new input parameter with the name 'paramName' the description 'description'. More...
|
|
void | addSynonymFor (string original, string synonym) |
| Stores that the parameter 'original' is also meant if 'synonym' was given as parameter. More...
|
|
void | checkInitializationAndThrow () const |
| Check if the Scenario was initialized and throws a RunException if it was not. More...
|
|
|
const string | scenarioName |
| A unique name of this scenario starting with "scn_".
|
|
const vector< string > | alternateNames |
| A vector containing all names for this Scenario, beyond scenarioName.
|
|
const string | scenarioDescriptor |
| Contains a description of how a call of this scenario may look like. More...
|
|
This test scenario takes a given set of rules and a given set of error graphs and performs a single backward step, including rule preparation.
- Author
- Jan Stückrath
This enumeration stores which order should be used.
Enumerator |
---|
MINOR |
The minor ordering.
|
SUBGRAPH |
The subgraph ordering.
|
void addParameter |
( |
string |
paramName, |
|
|
string |
description, |
|
|
bool |
mandatory = true |
|
) |
| |
|
protectedinherited |
Defined a new input parameter with the name 'paramName' the description 'description'.
The boolean specifies whether the parameter is mandatory or not. The order in which the parameters are defined using this method also specifies the order in which the parameters are expected if this scenario is called without parameter names, i.e. if the i-th input has only a value and no name, the name given at the i-th call of this method is used.
- Parameters
-
paramName | a unique name for this parameter |
description | a description of the defines parameter (for documentary purposes) |
mandatory | true if and only if the parameter should be mandatory |
void addSynonymFor |
( |
string |
original, |
|
|
string |
synonym |
|
) |
| |
|
protectedinherited |
Stores that the parameter 'original' is also meant if 'synonym' was given as parameter.
Using a defined parameter as 'synonym' will lead to undefined behavior.
- Parameters
-
original | an already defined parameter name |
synonym | a name which will from now on be handled as if 'original' was given |
void checkInitializationAndThrow |
( |
| ) |
const |
|
protectedinherited |
Check if the Scenario was initialized and throws a RunException if it was not.
- See Also
- exceptions::RunException
Returns the name of this Scenario, which is a string beginning with 'scn_'.
- Returns
- the name of this Scenario
string getScenarioDesciption |
( |
| ) |
const |
|
inherited |
Returns a full description of the given Scenario.
The description thereby contains an abstract description of the Scenarios functionality and a detailed description of all its parameters.
- Returns
- a full descrription ot the given Scenario
void initialize |
( |
vector< string > & |
params | ) |
|
|
inherited |
Initializes the current Scenario with the given vector of parameters.
Each element of 'params' must be of the form 'key=value' and 'key' has to be a defined parameter of the scenario.
- Parameters
-
params | a key-value vector of the scenario parameters |
void initialize |
( |
unordered_map< string, string > & |
parameters | ) |
|
|
overrideprotectedvirtual |
Initializes the scenario with the given mapping, where the keys are parameter names.
May throw a uncover::basic_types::InitialisationException if parameters are invalid.
- Parameters
-
parameters | a mapping containing parameter names as keys and their values |
Implements Scenario.
bool isInitialized |
( |
| ) |
const |
|
inherited |
Check whether the Scenario was already initialized or not.
- Returns
- true iff the Scenario was initialized
const string scenarioDescriptor |
|
protectedinherited |
Contains a description of how a call of this scenario may look like.
This does not include detailed description of the parameters.
The documentation for this class was generated from the following files:
- /home/stueckrath/eclipse_ws/Uncover/src/scenarios/BackwardStepTest.h
- /home/stueckrath/eclipse_ws/Uncover/src/scenarios/BackwardStepTest.cpp