Loading...
Searching...
No Matches
AisDataManipulator.h
1#ifndef AISDATAMANIPULATOR_H
2#define AISDATAMANIPULATOR_H
3
4#include "AisDataPoints.h"
5#include "AisErrorCode.h"
6#include "AisManipulatorType.h"
7#include "AisSquidstatGlobal.h"
8#include <iostream>
9#include <string>
10#include <memory>
11
12class AisDataManipulatorPrivate;
13
20class SQUIDSTATLIBRARY_EXPORT AisDataManipulator
21{
22public:
27
38 AisErrorCode setPulseType(AisPulseType type, double pulseWidth, double pulsePeriod);
39
49 AisErrorCode setPulseType(AisPulseType type, double frequency);
50
55 double getPulseWidth() const;
56
61 double getPulsePeriod() const;
62
67 double getFrequency() const;
68
73 bool isPulseCompleted() const;
74
79 double getBaseCurrent() const;
80
85 double getPulseCurrent() const;
86
91 double getBaseVoltage() const;
92
97 double getPulseVoltage() const;
98
103 void loadPrimaryData(const AisDCData& data);
104
105private:
106 std::shared_ptr<AisDataManipulatorPrivate> m_data;
107};
108
109#endif // AISDATAMANIPULATOR_H
This class offers advanced control over pulse data collection and manipulation. It provides methods t...
Definition AisDataManipulator.h:21
double getPulsePeriod() const
Get the pulse period.
void loadPrimaryData(const AisDCData &data)
Load primary data from AisDCData object.
double getPulseWidth() const
Get the pulse width.
AisErrorCode setPulseType(AisPulseType type, double pulseWidth, double pulsePeriod)
Set pulse type with pulse width and pulse period.
double getBaseCurrent() const
Get the base current.
bool isPulseCompleted() const
Check if the pulse is completed.
AisDataManipulator()
Default constructor for AisDataManipulator class.
double getPulseVoltage() const
Get the pulse voltage.
AisErrorCode setPulseType(AisPulseType type, double frequency)
Set pulse type with frequency.
double getBaseVoltage() const
Get the base voltage.
double getPulseCurrent() const
Get the pulse current.
double getFrequency() const
Get the pulse frequency.
This class contains the possible error codes returned to the user when working with the API....
Definition AisErrorCode.h:18
AisPulseType
This enum represents different pulse types, it is intended to tell the AisDataManipulator class how t...
Definition AisManipulatorType.h:9
A structure containing DC data collected from the instrument.
Definition AisDataPoints.h:11