Files
Jungfraujoch/broker/gen/model/Plots.h
2025-10-01 11:18:10 +02:00

115 lines
4.0 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. # 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.88
* 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.
*/
/*
* Plots.h
*
*
*/
#ifndef Plots_H_
#define Plots_H_
#include "Plot.h"
#include <string>
#include <vector>
#include "Plot_unit_x.h"
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
///
/// </summary>
class Plots
{
public:
Plots();
virtual ~Plots() = 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 Plots& rhs) const;
bool operator!=(const Plots& rhs) const;
/////////////////////////////////////////////
/// Plots members
/// <summary>
///
/// </summary>
std::string getTitle() const;
void setTitle(std::string const& value);
bool titleIsSet() const;
void unsetTitle();
/// <summary>
///
/// </summary>
org::openapitools::server::model::Plot_unit_x getUnitX() const;
void setUnitX(org::openapitools::server::model::Plot_unit_x const& value);
/// <summary>
/// Max X range of the plot
/// </summary>
float getSizeX() const;
void setSizeX(float const value);
bool sizeXIsSet() const;
void unsetSize_x();
/// <summary>
/// Max Y range of the plot
/// </summary>
float getSizeY() const;
void setSizeY(float const value);
bool sizeYIsSet() const;
void unsetSize_y();
/// <summary>
///
/// </summary>
std::vector<org::openapitools::server::model::Plot> getPlot() const;
void setPlot(std::vector<org::openapitools::server::model::Plot> const& value);
friend void to_json(nlohmann::json& j, const Plots& o);
friend void from_json(const nlohmann::json& j, Plots& o);
protected:
std::string m_Title;
bool m_TitleIsSet;
org::openapitools::server::model::Plot_unit_x m_Unit_x;
float m_Size_x;
bool m_Size_xIsSet;
float m_Size_y;
bool m_Size_yIsSet;
std::vector<org::openapitools::server::model::Plot> m_Plot;
};
} // namespace org::openapitools::server::model
#endif /* Plots_H_ */