Jungfraujoch/broker/gen/model/Azim_int_settings.h

/**
* 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.  # License Clarification  While this API definition is licensed under GPL-3.0, **the GPL copyleft provisions do not apply** when this file is used solely to generate OpenAPI clients or when implementing applications that interact with the API. Generated client code and applications using this API definition are not subject to the GPL license requirements and may be distributed under terms of your choosing.  This exception is similar in spirit to the Linux Kernel's approach to userspace API headers and the GCC Runtime Library Exception. The Linux Kernel developers have explicitly stated that user programs that merely use the kernel interfaces (syscalls, ioctl definitions, etc.) are not derivative works of the kernel and are not subject to the terms of the GPL.  This exception is intended to allow wider use of this API specification without imposing GPL requirements on applications that merely interact with the API, regardless of whether they communicate through network calls or other mechanisms. 
*
* The version of the OpenAPI document: 1.0.0-rc.161
* 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 azimuthal integration (polarization factor must be configured in dataset settings)
    /// </summary>
    bool isPolarizationCorr() const;
    void setPolarizationCorr(bool const value);
    /// <summary>
    /// Apply solid angle correction for azimuthal integration
    /// </summary>
    bool isSolidAngleCorr() const;
    void setSolidAngleCorr(bool const value);
    /// <summary>
    /// Upper q limit of the azimuthal integration [1/Angstrom]. Optional: if omitted, the integration (and the adaptive spot detection that shares these q bins) extends to the highest q the detector reaches. 
    /// </summary>
    float getHighQRecipA() const;
    void setHighQRecipA(float const value);
    bool highQRecipAIsSet() const;
    void unsetHigh_q_recipA();
    /// <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 azimuthal integration
    /// </summary>
    int64_t getAzimuthalBins() const;
    void setAzimuthalBins(int64_t const value);
    bool azimuthalBinsIsSet() const;
    void unsetAzimuthal_bins();
    /// <summary>
    /// Force CPU processing of azimuthal integration in the FPGA data acquisition workflow. This allows to extend number of azimuthal integration bins, as well as to calculate standard deviation of the azimuthal integration results. 
    /// </summary>
    bool isForceCpu() const;
    void setForceCpu(bool const value);
    bool forceCpuIsSet() const;
    void unsetForce_cpu();

    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;
    bool m_High_q_recipAIsSet;
    float m_Low_q_recipA;

    float m_Q_spacing;

    int64_t m_Azimuthal_bins;
    bool m_Azimuthal_binsIsSet;
    bool m_Force_cpu;
    bool m_Force_cpuIsSet;
    
};

} // namespace org::openapitools::server::model

#endif /* Azim_int_settings_H_ */