Jungfraujoch/broker/gen/model/Image_buffer_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.173
* 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.
*/
/*
 * Image_buffer_status.h
 *
 * 
 */

#ifndef Image_buffer_status_H_
#define Image_buffer_status_H_


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

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

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

    /////////////////////////////////////////////
    /// Image_buffer_status members

    /// <summary>
    /// Smallest image number available in the buffer
    /// </summary>
    int64_t getMinImageNumber() const;
    void setMinImageNumber(int64_t const value);
    /// <summary>
    /// Largest image number available in the buffer
    /// </summary>
    int64_t getMaxImageNumber() const;
    void setMaxImageNumber(int64_t const value);
    /// <summary>
    /// Image numbers currently present in the buffer.
    /// </summary>
    std::vector<int64_t> getImageNumbers() const;
    void setImageNumbers(std::vector<int64_t> const value);
    /// <summary>
    /// Number of slots in the image buffer. This number, compared to number of images in data collection and frame rate will determine \&quot;retention\&quot; rate of the image buffer. 
    /// </summary>
    int64_t getTotalSlots() const;
    void setTotalSlots(int64_t const value);
    /// <summary>
    /// Slots available for the data collection
    /// </summary>
    int64_t getAvailableSlots() const;
    void setAvailableSlots(int64_t const value);
    /// <summary>
    /// Number of slots in the image buffer that are currently in preparation for sending. 
    /// </summary>
    int64_t getInPreparationSlots() const;
    void setInPreparationSlots(int64_t const value);
    /// <summary>
    /// Number of slots in the image buffer that are currently sending/writing data. 
    /// </summary>
    int64_t getInSendingSlots() const;
    void setInSendingSlots(int64_t const value);
    /// <summary>
    /// Counter of changes in the image buffer - either new start message or new image added. For optimization one can only load new images/datasets from the HTTP if this value changes. Counter is optional as it was not implemented in older versions to avoid breaking change 
    /// </summary>
    int64_t getCurrentCounter() const;
    void setCurrentCounter(int64_t const value);
    bool currentCounterIsSet() const;
    void unsetCurrent_counter();

    friend  void to_json(nlohmann::json& j, const Image_buffer_status& o);
    friend  void from_json(const nlohmann::json& j, Image_buffer_status& o);
protected:
    int64_t m_Min_image_number;

    int64_t m_Max_image_number;

    std::vector<int64_t> m_Image_numbers;

    int64_t m_Total_slots;

    int64_t m_Available_slots;

    int64_t m_In_preparation_slots;

    int64_t m_In_sending_slots;

    int64_t m_Current_counter;
    bool m_Current_counterIsSet;
    
};

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

#endif /* Image_buffer_status_H_ */