Jungfraujoch/broker/gen/model/Broker_status.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.103
* 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.
*/
/*
 * Broker_status.h
 *
 * 
 */

#ifndef Broker_status_H_
#define Broker_status_H_


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

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

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

    /////////////////////////////////////////////
    /// Broker_status members

    /// <summary>
    /// 
    /// </summary>
    std::string getState() const;
    void setState(std::string const& value);
    /// <summary>
    /// Progress of data collection (only available if receiving is running)
    /// </summary>
    float getProgress() const;
    void setProgress(float const value);
    bool progressIsSet() const;
    void unsetProgress();
    /// <summary>
    /// Message to display besides state of the jfjoch_broker; mostly used for errors and warnings This matters especially for async functions (start/initialize), where API won&#39;t return reason for the error during async operation. 
    /// </summary>
    std::string getMessage() const;
    void setMessage(std::string const& value);
    bool messageIsSet() const;
    void unsetMessage();
    /// <summary>
    /// Level of the message to display
    /// </summary>
    std::string getMessageSeverity() const;
    void setMessageSeverity(std::string const& value);
    bool messageSeverityIsSet() const;
    void unsetMessage_severity();
    /// <summary>
    /// Number of installed GPUs
    /// </summary>
    int32_t getGpuCount() const;
    void setGpuCount(int32_t const value);
    bool gpuCountIsSet() const;
    void unsetGpu_count();

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

    float m_Progress;
    bool m_ProgressIsSet;
    std::string m_Message;
    bool m_MessageIsSet;
    std::string m_Message_severity;
    bool m_Message_severityIsSet;
    int32_t m_Gpu_count;
    bool m_Gpu_countIsSet;
    
};

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

#endif /* Broker_status_H_ */