Files
Jungfraujoch/broker/gen/model/Jfjoch_statistics.h
2025-07-15 09:55:19 +02:00

251 lines
9.6 KiB
C++

/**
* Jungfraujoch
* API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland). Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU. Jungfraujoch uses FPGA boards to acquire data at high data rates.
*
* The version of the OpenAPI document: 1.0.0-rc.64
* Contact: filip.leonarski@psi.ch
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
/*
* Jfjoch_statistics.h
*
* Pool statistics for Jungfraujoch to reduce transfers between frontend and jfjoch_broker
*/
#ifndef Jfjoch_statistics_H_
#define Jfjoch_statistics_H_
#include "Calibration_statistics_inner.h"
#include "Broker_status.h"
#include "Pixel_mask_statistics.h"
#include "Measurement_statistics.h"
#include "Spot_finding_settings.h"
#include "Zeromq_preview_settings.h"
#include "Detector_list.h"
#include "File_writer_settings.h"
#include "Azim_int_settings.h"
#include "Image_format_settings.h"
#include "Zeromq_metadata_settings.h"
#include "Detector_settings.h"
#include <vector>
#include "Indexing_settings.h"
#include "Detector_status.h"
#include "Roi_definitions.h"
#include "Fpga_status_inner.h"
#include "Image_buffer_status.h"
#include "Instrument_metadata.h"
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// Pool statistics for Jungfraujoch to reduce transfers between frontend and jfjoch_broker
/// </summary>
class Jfjoch_statistics
{
public:
Jfjoch_statistics();
virtual ~Jfjoch_statistics() = default;
/// <summary>
/// Validate the current data in the model. Throws a ValidationException on failure.
/// </summary>
void validate() const;
/// <summary>
/// Validate the current data in the model. Returns false on error and writes an error
/// message into the given stringstream.
/// </summary>
bool validate(std::stringstream& msg) const;
/// <summary>
/// Helper overload for validate. Used when one model stores another model and calls it's validate.
/// Not meant to be called outside that case.
/// </summary>
bool validate(std::stringstream& msg, const std::string& pathPrefix) const;
bool operator==(const Jfjoch_statistics& rhs) const;
bool operator!=(const Jfjoch_statistics& rhs) const;
/////////////////////////////////////////////
/// Jfjoch_statistics members
/// <summary>
///
/// </summary>
org::openapitools::server::model::Detector_status getDetector() const;
void setDetector(org::openapitools::server::model::Detector_status const& value);
bool detectorIsSet() const;
void unsetDetector();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Detector_list getDetectorList() const;
void setDetectorList(org::openapitools::server::model::Detector_list const& value);
bool detectorListIsSet() const;
void unsetDetector_list();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Detector_settings getDetectorSettings() const;
void setDetectorSettings(org::openapitools::server::model::Detector_settings const& value);
bool detectorSettingsIsSet() const;
void unsetDetector_settings();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Image_format_settings getImageFormatSettings() const;
void setImageFormatSettings(org::openapitools::server::model::Image_format_settings const& value);
bool imageFormatSettingsIsSet() const;
void unsetImage_format_settings();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Instrument_metadata getInstrumentMetadata() const;
void setInstrumentMetadata(org::openapitools::server::model::Instrument_metadata const& value);
bool instrumentMetadataIsSet() const;
void unsetInstrument_metadata();
/// <summary>
///
/// </summary>
org::openapitools::server::model::File_writer_settings getFileWriterSettings() const;
void setFileWriterSettings(org::openapitools::server::model::File_writer_settings const& value);
bool fileWriterSettingsIsSet() const;
void unsetFile_writer_settings();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Spot_finding_settings getDataProcessingSettings() const;
void setDataProcessingSettings(org::openapitools::server::model::Spot_finding_settings const& value);
bool dataProcessingSettingsIsSet() const;
void unsetData_processing_settings();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Measurement_statistics getMeasurement() const;
void setMeasurement(org::openapitools::server::model::Measurement_statistics const& value);
bool measurementIsSet() const;
void unsetMeasurement();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Broker_status getBroker() const;
void setBroker(org::openapitools::server::model::Broker_status const& value);
bool brokerIsSet() const;
void unsetBroker();
/// <summary>
///
/// </summary>
std::vector<org::openapitools::server::model::Fpga_status_inner> getFpga() const;
void setFpga(std::vector<org::openapitools::server::model::Fpga_status_inner> const& value);
bool fpgaIsSet() const;
void unsetFpga();
/// <summary>
///
/// </summary>
std::vector<org::openapitools::server::model::Calibration_statistics_inner> getCalibration() const;
void setCalibration(std::vector<org::openapitools::server::model::Calibration_statistics_inner> const& value);
bool calibrationIsSet() const;
void unsetCalibration();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Zeromq_preview_settings getZeromqPreview() const;
void setZeromqPreview(org::openapitools::server::model::Zeromq_preview_settings const& value);
bool zeromqPreviewIsSet() const;
void unsetZeromq_preview();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Zeromq_metadata_settings getZeromqMetadata() const;
void setZeromqMetadata(org::openapitools::server::model::Zeromq_metadata_settings const& value);
bool zeromqMetadataIsSet() const;
void unsetZeromq_metadata();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Pixel_mask_statistics getPixelMask() const;
void setPixelMask(org::openapitools::server::model::Pixel_mask_statistics const& value);
bool pixelMaskIsSet() const;
void unsetPixel_mask();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Roi_definitions getRoi() const;
void setRoi(org::openapitools::server::model::Roi_definitions const& value);
bool roiIsSet() const;
void unsetRoi();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Azim_int_settings getAzInt() const;
void setAzInt(org::openapitools::server::model::Azim_int_settings const& value);
bool azIntIsSet() const;
void unsetAz_int();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Image_buffer_status getBuffer() const;
void setBuffer(org::openapitools::server::model::Image_buffer_status const& value);
bool bufferIsSet() const;
void unsetBuffer();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Indexing_settings getIndexing() const;
void setIndexing(org::openapitools::server::model::Indexing_settings const& value);
bool indexingIsSet() const;
void unsetIndexing();
friend void to_json(nlohmann::json& j, const Jfjoch_statistics& o);
friend void from_json(const nlohmann::json& j, Jfjoch_statistics& o);
protected:
org::openapitools::server::model::Detector_status m_Detector;
bool m_DetectorIsSet;
org::openapitools::server::model::Detector_list m_Detector_list;
bool m_Detector_listIsSet;
org::openapitools::server::model::Detector_settings m_Detector_settings;
bool m_Detector_settingsIsSet;
org::openapitools::server::model::Image_format_settings m_Image_format_settings;
bool m_Image_format_settingsIsSet;
org::openapitools::server::model::Instrument_metadata m_Instrument_metadata;
bool m_Instrument_metadataIsSet;
org::openapitools::server::model::File_writer_settings m_File_writer_settings;
bool m_File_writer_settingsIsSet;
org::openapitools::server::model::Spot_finding_settings m_Data_processing_settings;
bool m_Data_processing_settingsIsSet;
org::openapitools::server::model::Measurement_statistics m_Measurement;
bool m_MeasurementIsSet;
org::openapitools::server::model::Broker_status m_Broker;
bool m_BrokerIsSet;
std::vector<org::openapitools::server::model::Fpga_status_inner> m_Fpga;
bool m_FpgaIsSet;
std::vector<org::openapitools::server::model::Calibration_statistics_inner> m_Calibration;
bool m_CalibrationIsSet;
org::openapitools::server::model::Zeromq_preview_settings m_Zeromq_preview;
bool m_Zeromq_previewIsSet;
org::openapitools::server::model::Zeromq_metadata_settings m_Zeromq_metadata;
bool m_Zeromq_metadataIsSet;
org::openapitools::server::model::Pixel_mask_statistics m_Pixel_mask;
bool m_Pixel_maskIsSet;
org::openapitools::server::model::Roi_definitions m_Roi;
bool m_RoiIsSet;
org::openapitools::server::model::Azim_int_settings m_Az_int;
bool m_Az_intIsSet;
org::openapitools::server::model::Image_buffer_status m_Buffer;
bool m_BufferIsSet;
org::openapitools::server::model::Indexing_settings m_Indexing;
bool m_IndexingIsSet;
};
} // namespace org::openapitools::server::model
#endif /* Jfjoch_statistics_H_ */