aboutsummaryrefslogtreecommitdiff
path: root/tests/framework/instruments/Instrument.h
diff options
context:
space:
mode:
Diffstat (limited to 'tests/framework/instruments/Instrument.h')
-rw-r--r--tests/framework/instruments/Instrument.h16
1 files changed, 13 insertions, 3 deletions
diff --git a/tests/framework/instruments/Instrument.h b/tests/framework/instruments/Instrument.h
index e25939a284..0df53f4210 100644
--- a/tests/framework/instruments/Instrument.h
+++ b/tests/framework/instruments/Instrument.h
@@ -57,13 +57,19 @@ public:
template <typename T, ScaleFactor scale>
static std::unique_ptr<Instrument> make_instrument();
+ /** Default constructor. */
Instrument() = default;
+ /** Allow instances of this class to be copy constructed */
Instrument(const Instrument &) = default;
- Instrument(Instrument &&) = default;
+ /** Allow instances of this class to be move constructed */
+ Instrument(Instrument &&) = default;
+ /** Allow instances of this class to be copied */
Instrument &operator=(const Instrument &) = default;
+ /** Allow instances of this class to be moved */
Instrument &operator=(Instrument &&) = default;
- virtual ~Instrument() = default;
+ /** Default destructor. */
+ virtual ~Instrument() = default;
/** Identifier for the instrument */
virtual std::string id() const = 0;
@@ -74,9 +80,13 @@ public:
/** Stop measuring. */
virtual void stop() = 0;
+ /** Map of measurements */
using MeasurementsMap = std::map<std::string, Measurement>;
- /** Return the latest measurement. */
+ /** Return the latest measurement.
+ *
+ * @return the latest measurement.
+ */
virtual MeasurementsMap measurements() const = 0;
protected: