Jungfraujoch/broker/gen/model/Indexing_algorithm.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.164
* 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.
*/
/*
 * Indexing_algorithm.h
 *
 * Selection of an indexing algorithm used by Jungfraujoch 
 */

#ifndef Indexing_algorithm_H_
#define Indexing_algorithm_H_


#include <nlohmann/json.hpp>

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

/// <summary>
/// Selection of an indexing algorithm used by Jungfraujoch 
/// </summary>
class  Indexing_algorithm
{
public:
    Indexing_algorithm();
    virtual ~Indexing_algorithm() = default;

    enum class eIndexing_algorithm {
    // To have a valid default value.
    // Avoiding name clashes with user defined
    // enum values
    INVALID_VALUE_OPENAPI_GENERATED = 0,
    FFBIDX, 
    FFT, 
    FFTW, 
    AUTO, 
    NONE
    };

    /// <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 Indexing_algorithm& rhs) const;
    bool operator!=(const Indexing_algorithm& rhs) const;

    /////////////////////////////////////////////
    /// Indexing_algorithm members

    Indexing_algorithm::eIndexing_algorithm getValue() const;
    void setValue(Indexing_algorithm::eIndexing_algorithm value);
    
    friend  void to_json(nlohmann::json& j, const Indexing_algorithm& o);
    friend  void from_json(const nlohmann::json& j, Indexing_algorithm& o);
protected:
    Indexing_algorithm::eIndexing_algorithm m_value = Indexing_algorithm::eIndexing_algorithm::INVALID_VALUE_OPENAPI_GENERATED;
};

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

#endif /* Indexing_algorithm_H_ */