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

114 lines
3.1 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.
*/
/*
* Azim_int_settings.h
*
*
*/
#ifndef Azim_int_settings_H_
#define Azim_int_settings_H_
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
///
/// </summary>
class Azim_int_settings
{
public:
Azim_int_settings();
virtual ~Azim_int_settings() = 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 Azim_int_settings& rhs) const;
bool operator!=(const Azim_int_settings& rhs) const;
/////////////////////////////////////////////
/// Azim_int_settings members
/// <summary>
/// Apply polarization correction for radial integration (polarization factor must be configured in dataset settings)
/// </summary>
bool isPolarizationCorr() const;
void setPolarizationCorr(bool const value);
/// <summary>
/// Apply solid angle correction for radial integration
/// </summary>
bool isSolidAngleCorr() const;
void setSolidAngleCorr(bool const value);
/// <summary>
///
/// </summary>
float getHighQRecipA() const;
void setHighQRecipA(float const value);
/// <summary>
///
/// </summary>
float getLowQRecipA() const;
void setLowQRecipA(float const value);
/// <summary>
///
/// </summary>
float getQSpacing() const;
void setQSpacing(float const value);
/// <summary>
/// Numer of azimuthal (phi) bins; 1 &#x3D; standard 1D radial integration
/// </summary>
int64_t getAzimuthalBins() const;
void setAzimuthalBins(int64_t const value);
bool azimuthalBinsIsSet() const;
void unsetAzimuthal_bins();
friend void to_json(nlohmann::json& j, const Azim_int_settings& o);
friend void from_json(const nlohmann::json& j, Azim_int_settings& o);
protected:
bool m_Polarization_corr;
bool m_Solid_angle_corr;
float m_High_q_recipA;
float m_Low_q_recipA;
float m_Q_spacing;
int64_t m_Azimuthal_bins;
bool m_Azimuthal_binsIsSet;
};
} // namespace org::openapitools::server::model
#endif /* Azim_int_settings_H_ */