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

238 lines
6.3 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.
*/
/*
* Scan_result_images_inner.h
*
*
*/
#ifndef Scan_result_images_inner_H_
#define Scan_result_images_inner_H_
#include "Unit_cell.h"
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
///
/// </summary>
class Scan_result_images_inner
{
public:
Scan_result_images_inner();
virtual ~Scan_result_images_inner() = 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 Scan_result_images_inner& rhs) const;
bool operator!=(const Scan_result_images_inner& rhs) const;
/////////////////////////////////////////////
/// Scan_result_images_inner members
/// <summary>
///
/// </summary>
float getEfficiency() const;
void setEfficiency(float const value);
/// <summary>
/// Detector image number for a given cell
/// </summary>
int64_t getNumber() const;
void setNumber(int64_t const value);
/// <summary>
/// Cell position in X for grid scan
/// </summary>
int64_t getNx() const;
void setNx(int64_t const value);
bool nxIsSet() const;
void unsetNx();
/// <summary>
/// Cell position in Y for grid scan
/// </summary>
int64_t getNy() const;
void setNy(int64_t const value);
bool nyIsSet() const;
void unsetNy();
/// <summary>
/// Background estimate
/// </summary>
float getBkg() const;
void setBkg(float const value);
bool bkgIsSet() const;
void unsetBkg();
/// <summary>
/// Spot count
/// </summary>
int64_t getSpots() const;
void setSpots(int64_t const value);
bool spotsIsSet() const;
void unsetSpots();
/// <summary>
/// Spot count in low resolution range
/// </summary>
int64_t getSpotsLowRes() const;
void setSpotsLowRes(int64_t const value);
bool spotsLowResIsSet() const;
void unsetSpots_low_res();
/// <summary>
/// Spot count within indexing tolerance
/// </summary>
int64_t getSpotsIndexed() const;
void setSpotsIndexed(int64_t const value);
bool spotsIndexedIsSet() const;
void unsetSpots_indexed();
/// <summary>
/// Spot count within common ice ring resolutions
/// </summary>
int64_t getSpotsIce() const;
void setSpotsIce(int64_t const value);
bool spotsIceIsSet() const;
void unsetSpots_ice();
/// <summary>
/// Indexing solution
/// </summary>
int64_t getIndex() const;
void setIndex(int64_t const value);
bool indexIsSet() const;
void unsetIndex();
/// <summary>
/// Mosaicity estimate
/// </summary>
float getMos() const;
void setMos(float const value);
bool mosIsSet() const;
void unsetMos();
/// <summary>
/// B-Factor estimate
/// </summary>
float getB() const;
void setB(float const value);
bool BIsSet() const;
void unsetb();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Unit_cell getUc() const;
void setUc(org::openapitools::server::model::Unit_cell const& value);
bool ucIsSet() const;
void unsetUc();
/// <summary>
/// XFEL pulse ID
/// </summary>
int64_t getXfelPulseid() const;
void setXfelPulseid(int64_t const value);
bool xfelPulseidIsSet() const;
void unsetXfel_pulseid();
/// <summary>
/// Total sum of all pixels
/// </summary>
int64_t getPixelSum() const;
void setPixelSum(int64_t const value);
bool pixelSumIsSet() const;
void unsetPixel_sum();
/// <summary>
/// Max viable pixel
/// </summary>
int64_t getMax() const;
void setMax(int64_t const value);
bool maxIsSet() const;
void unsetMax();
/// <summary>
/// Number of saturated pixels
/// </summary>
int64_t getSat() const;
void setSat(int64_t const value);
bool satIsSet() const;
void unsetSat();
/// <summary>
/// Number of error pixels
/// </summary>
int64_t getErr() const;
void setErr(int64_t const value);
bool errIsSet() const;
void unsetErr();
/// <summary>
/// Resolution estimate from ML algorithm
/// </summary>
float getRes() const;
void setRes(float const value);
bool resIsSet() const;
void unsetRes();
friend void to_json(nlohmann::json& j, const Scan_result_images_inner& o);
friend void from_json(const nlohmann::json& j, Scan_result_images_inner& o);
protected:
float m_Efficiency;
int64_t m_number;
int64_t m_Nx;
bool m_NxIsSet;
int64_t m_Ny;
bool m_NyIsSet;
float m_Bkg;
bool m_BkgIsSet;
int64_t m_Spots;
bool m_SpotsIsSet;
int64_t m_Spots_low_res;
bool m_Spots_low_resIsSet;
int64_t m_Spots_indexed;
bool m_Spots_indexedIsSet;
int64_t m_Spots_ice;
bool m_Spots_iceIsSet;
int64_t m_Index;
bool m_IndexIsSet;
float m_Mos;
bool m_MosIsSet;
float m_b;
bool m_bIsSet;
org::openapitools::server::model::Unit_cell m_Uc;
bool m_UcIsSet;
int64_t m_Xfel_pulseid;
bool m_Xfel_pulseidIsSet;
int64_t m_Pixel_sum;
bool m_Pixel_sumIsSet;
int64_t m_Max;
bool m_MaxIsSet;
int64_t m_Sat;
bool m_SatIsSet;
int64_t m_Err;
bool m_ErrIsSet;
float m_Res;
bool m_ResIsSet;
};
} // namespace org::openapitools::server::model
#endif /* Scan_result_images_inner_H_ */