Squidstat API User Manual
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
20class AisDataManipulatorPrivate;
21class SQUIDSTATLIBRARY_EXPORT AisDataManipulator {
22
23public:
28
39 AisErrorCode setPulseType(AisPulseType type, double pulseWidth, double pulsePeriod);
40
50 AisErrorCode setPulseType(AisPulseType type, double frequency);
51
56 double getPulseWidth() const;
57
62 double getPulsePeriod() const;
63
68 double getFrequency() const;
69
74 bool isPulseCompleted() const;
75
80 double getBaseCurrent() const;
81
86 double getPulseCurrent() const;
87
92 double getBaseVoltage() const;
93
98 double getPulseVoltage() const;
99
104 void loadPrimaryData(const AisDCData& data);
105
106private:
107 std::shared_ptr<AisDataManipulatorPrivate> m_data;
108};
109
110#endif // AISDATAMANIPULATOR_H
The AisDataManipulator class offers advanced control over pulse data collection and manipulation....
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:15
a structure containing DC data information.
Definition: AisDataPoints.h:9