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

131 lines
3.7 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.
*/
/*
* Preview_settings.h
*
* Settings for JPEG rendering of preview images
*/
#ifndef Preview_settings_H_
#define Preview_settings_H_
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// Settings for JPEG rendering of preview images
/// </summary>
class Preview_settings
{
public:
Preview_settings();
virtual ~Preview_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 Preview_settings& rhs) const;
bool operator!=(const Preview_settings& rhs) const;
/////////////////////////////////////////////
/// Preview_settings members
/// <summary>
/// Saturation value to set contrast in the preview image
/// </summary>
int64_t getSaturation() const;
void setSaturation(int64_t const value);
/// <summary>
/// Show spot finding results on the image
/// </summary>
bool isShowSpots() const;
void setShowSpots(bool const value);
bool showSpotsIsSet() const;
void unsetShow_spots();
/// <summary>
/// Show ROI areas on the image
/// </summary>
bool isShowRoi() const;
void setShowRoi(bool const value);
bool showRoiIsSet() const;
void unsetShow_roi();
/// <summary>
/// Quality of JPEG image (100 - highest; 0 - lowest)
/// </summary>
int64_t getJpegQuality() const;
void setJpegQuality(int64_t const value);
bool jpegQualityIsSet() const;
void unsetJpeg_quality();
/// <summary>
/// Preview indexed images only
/// </summary>
bool isShowIndexed() const;
void setShowIndexed(bool const value);
bool showIndexedIsSet() const;
void unsetShow_indexed();
/// <summary>
/// Show user mask
/// </summary>
bool isShowUserMask() const;
void setShowUserMask(bool const value);
bool showUserMaskIsSet() const;
void unsetShow_user_mask();
/// <summary>
///
/// </summary>
float getResolutionRing() const;
void setResolutionRing(float const value);
bool resolutionRingIsSet() const;
void unsetResolution_ring();
friend void to_json(nlohmann::json& j, const Preview_settings& o);
friend void from_json(const nlohmann::json& j, Preview_settings& o);
protected:
int64_t m_Saturation;
bool m_Show_spots;
bool m_Show_spotsIsSet;
bool m_Show_roi;
bool m_Show_roiIsSet;
int64_t m_Jpeg_quality;
bool m_Jpeg_qualityIsSet;
bool m_Show_indexed;
bool m_Show_indexedIsSet;
bool m_Show_user_mask;
bool m_Show_user_maskIsSet;
float m_Resolution_ring;
bool m_Resolution_ringIsSet;
};
} // namespace org::openapitools::server::model
#endif /* Preview_settings_H_ */