this class is used to create custom experiments. A custom experiment contains one or more elements. Once you create elements and set their parameters, you can add them to the container.
More...
#include <AisExperiment.h>
|
|
class | AisInstrumentHandler |
| |
this class is used to create custom experiments. A custom experiment contains one or more elements. Once you create elements and set their parameters, you can add them to the container.
- Note
- we call the basic experiments -that are used to build more complex custom experiments- elements. In contexts where both elements and custom experiments are used, elements will be referred to as elements to make the distinction. In other contexts, elements may also be referred to as experiments as they may indeed be used as experiments.
◆ AisExperiment()
this is the copy constructor for the custom experiment.
- Parameters
-
| exp | the custom experiment to copy from. |
◆ appendElement()
| bool AisExperiment::appendElement |
( |
AisAbstractElement & |
element, |
|
|
unsigned int |
repeat = 1 |
|
) |
| |
append an element to the custom experiment.
- Parameters
-
| element | an elemental experiment to be appended to this/(the calling) custom experiment. |
| repeat | the number of times this element is to be repeated. This is an optional parameter and is defaulted to equal 1 when not set. |
- Returns
- true if appending the element was successful and false otherwise.
- Note
- although an element is an experiment, in the context of custom experiments, it is referred to as an element to make a distinction between the two. In other contexts where such distinction is not needed, an element may still be referred to as an experiment.
◆ appendSubExperiment()
| bool AisExperiment::appendSubExperiment |
( |
const AisExperiment & |
subExp, |
|
|
unsigned int |
repeat = 1 |
|
) |
| |
append a sub experiment to this/(the calling) custom experiment.
- Parameters
-
| subExp | a sub experiment to be appended to this/(the calling) custom experiment. |
| repeat | the number of times this sub experiment is to be repeated. This is an optional parameter and is defaulted to equal 1 when not set. |
- Returns
- true if appending the sub experiment was successful and false otherwise.
◆ getCategory()
| QStringList AisExperiment::getCategory |
( |
| ) |
const |
get the category for the custom experiment.
- Returns
- the category set for the custom experiment. If no category has been set, the default category returned is ("Custom").
◆ getDescription()
| QString AisExperiment::getDescription |
( |
| ) |
const |
get a brief description of the custom experiment.
- Returns
- the description set for the custom experiment. If no description has been set, the default description returned is "Not Defined".
◆ getExperimentName()
| QString AisExperiment::getExperimentName |
( |
| ) |
const |
get the name of the custom experiment.
- Returns
- the name set for the custom experiment. If no name has been set, the default name returned is "Custom Experiment"
◆ operator=()
the assignment operator for the custom experiment.
- Parameters
-
| exp | the custom experiment to copy from. |
◆ setDescription()
| void AisExperiment::setDescription |
( |
QString |
description | ) |
|
set a description for the experiment.
- Parameters
-
| description | the description to be set for the custom experiment. |
◆ setExperimentName()
| void AisExperiment::setExperimentName |
( |
QString |
name | ) |
|
set a name for the custom experiment.
- Parameters
-
| name | the name to be set for the custom experiment. |
The documentation for this class was generated from the following file:
1.9.5