Squidstat API User Manual
Loading...
Searching...
No Matches
AisExperiment.h
1#ifndef SQUIDSTATLIBRARY_AISCUSTOMEXPERIMENTRUNNER_H
2#define SQUIDSTATLIBRARY_AISCUSTOMEXPERIMENTRUNNER_H
3
4#include "AisSquidstatGlobal.h"
5#include "experiments/builder_elements/AisAbstractElement.h"
6#include <QString>
7
8class CustomExperimentRunner;
9class AisExperimentPrivate;
10
19class SQUIDSTATLIBRARY_EXPORT AisExperiment final {
20public:
24 explicit AisExperiment();
25
30 explicit AisExperiment(const AisExperiment& exp);
31
36 void operator=(const AisExperiment& exp);
37
39
45 QString getExperimentName() const;
46
52 QString getDescription() const;
53
59 QStringList getCategory() const;
60
65 void setExperimentName(QString name);
66
71 void setDescription(QString description);
72
81 bool appendElement(AisAbstractElement& element, unsigned int repeat = 1);
82
89 bool appendSubExperiment(const AisExperiment& subExp, unsigned int repeat = 1);
90
91private:
92 friend class AisInstrumentHandler;
93 std::shared_ptr<AisExperimentPrivate> m_data;
94};
95
96#endif //SQUIDSTATLIBRARY_AISCUSTOMEXPERIMENTRUNNER_H
this class is used to create custom experiments. A custom experiment contains one or more elements....
Definition: AisExperiment.h:19
bool appendSubExperiment(const AisExperiment &subExp, unsigned int repeat=1)
append a sub experiment to this/(the calling) custom experiment.
QStringList getCategory() const
get the category for the custom experiment.
AisExperiment()
this is the default constructor for the custom experiment.
QString getExperimentName() const
get the name of the custom experiment.
bool appendElement(AisAbstractElement &element, unsigned int repeat=1)
append an element to the custom experiment.
AisExperiment(const AisExperiment &exp)
this is the copy constructor for the custom experiment.
void setExperimentName(QString name)
set a name for the custom experiment.
void operator=(const AisExperiment &exp)
the assignment operator for the custom experiment.
void setDescription(QString description)
set a description for the experiment.
QString getDescription() const
get a brief description of the custom experiment.
this class provides control of the device including starting, pausing, resuming and stopping an exper...
Definition: AisInstrumentHandler.h:24