Files
Jungfraujoch/broker/gen/model/Roi_azimuthal.h
2025-07-03 15:10:04 +02:00

92 lines
2.5 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.58
* 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.
*/
/*
* Roi_azimuthal.h
*
* ROI as Q-range (or resolution range)
*/
#ifndef Roi_azimuthal_H_
#define Roi_azimuthal_H_
#include <string>
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// ROI as Q-range (or resolution range)
/// </summary>
class Roi_azimuthal
{
public:
Roi_azimuthal();
virtual ~Roi_azimuthal() = 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 Roi_azimuthal& rhs) const;
bool operator!=(const Roi_azimuthal& rhs) const;
/////////////////////////////////////////////
/// Roi_azimuthal members
/// <summary>
/// Name for the ROI; used in the plots
/// </summary>
std::string getName() const;
void setName(std::string const& value);
/// <summary>
/// Minimum Q-range for the ROI
/// </summary>
float getQMinRecipA() const;
void setQMinRecipA(float const value);
/// <summary>
/// Maximum Q-range for the ROI
/// </summary>
float getQMaxRecipA() const;
void setQMaxRecipA(float const value);
friend void to_json(nlohmann::json& j, const Roi_azimuthal& o);
friend void from_json(const nlohmann::json& j, Roi_azimuthal& o);
protected:
std::string m_Name;
float m_Q_min_recipA;
float m_Q_max_recipA;
};
} // namespace org::openapitools::server::model
#endif /* Roi_azimuthal_H_ */