Files
Jungfraujoch/broker/gen/model/Roi_circle.h
2024-11-22 21:25:20 +01:00

99 lines
2.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.25
* 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_circle.h
*
* Circular ROI
*/
#ifndef Roi_circle_H_
#define Roi_circle_H_
#include <string>
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// Circular ROI
/// </summary>
class Roi_circle
{
public:
Roi_circle();
virtual ~Roi_circle() = 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_circle& rhs) const;
bool operator!=(const Roi_circle& rhs) const;
/////////////////////////////////////////////
/// Roi_circle members
/// <summary>
/// Name for the ROI; used in the plots
/// </summary>
std::string getName() const;
void setName(std::string const& value);
/// <summary>
/// X coordinate of center of the circle [pixels]
/// </summary>
float getCenterXPxl() const;
void setCenterXPxl(float const value);
/// <summary>
/// Y coordinate of center of the circle [pixels]
/// </summary>
float getCenterYPxl() const;
void setCenterYPxl(float const value);
/// <summary>
/// Radius of the circle [pixels]
/// </summary>
float getRadiusPxl() const;
void setRadiusPxl(float const value);
friend void to_json(nlohmann::json& j, const Roi_circle& o);
friend void from_json(const nlohmann::json& j, Roi_circle& o);
protected:
std::string m_Name;
float m_Center_x_pxl;
float m_Center_y_pxl;
float m_Radius_pxl;
};
} // namespace org::openapitools::server::model
#endif /* Roi_circle_H_ */