Jungfraujoch/broker/gen/model/Roi_box.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.109
* 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_box.h
 *
 * Box ROI
 */

#ifndef Roi_box_H_
#define Roi_box_H_


#include <string>
#include <nlohmann/json.hpp>

namespace org::openapitools::server::model
{

/// <summary>
/// Box ROI
/// </summary>
class  Roi_box
{
public:
    Roi_box();
    virtual ~Roi_box() = 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_box& rhs) const;
    bool operator!=(const Roi_box& rhs) const;

    /////////////////////////////////////////////
    /// Roi_box members

    /// <summary>
    /// Name for the ROI; used in the plots
    /// </summary>
    std::string getName() const;
    void setName(std::string const& value);
    /// <summary>
    /// Lower bound (inclusive) in X coordinate for the box
    /// </summary>
    int64_t getMinXPxl() const;
    void setMinXPxl(int64_t const value);
    /// <summary>
    /// Upper bound (inclusive) in X coordinate for the box
    /// </summary>
    int64_t getMaxXPxl() const;
    void setMaxXPxl(int64_t const value);
    /// <summary>
    /// Lower bound (inclusive) in Y coordinate for the box
    /// </summary>
    int64_t getMinYPxl() const;
    void setMinYPxl(int64_t const value);
    /// <summary>
    /// Upper bound (inclusive) in Y coordinate for the box
    /// </summary>
    int64_t getMaxYPxl() const;
    void setMaxYPxl(int64_t const value);

    friend  void to_json(nlohmann::json& j, const Roi_box& o);
    friend  void from_json(const nlohmann::json& j, Roi_box& o);
protected:
    std::string m_Name;

    int64_t m_Min_x_pxl;

    int64_t m_Max_x_pxl;

    int64_t m_Min_y_pxl;

    int64_t m_Max_y_pxl;

    
};

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

#endif /* Roi_box_H_ */