Jungfraujoch/broker/gen/model/Scan_result.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.162
* 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.
*/
/*
 * Scan_result.h
 *
 * Results of a scan
 */

#ifndef Scan_result_H_
#define Scan_result_H_


#include "Scan_result_images_inner.h"
#include "Unit_cell.h"
#include <string>
#include <vector>
#include <nlohmann/json.hpp>

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

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

    /////////////////////////////////////////////
    /// Scan_result members

    /// <summary>
    /// 
    /// </summary>
    std::string getFilePrefix() const;
    void setFilePrefix(std::string const& value);
    bool filePrefixIsSet() const;
    void unsetFile_prefix();
    /// <summary>
    /// 
    /// </summary>
    org::openapitools::server::model::Unit_cell getRotationUnitCell() const;
    void setRotationUnitCell(org::openapitools::server::model::Unit_cell const& value);
    bool rotationUnitCellIsSet() const;
    void unsetRotation_unit_cell();
    /// <summary>
    /// Real-space crystal lattice 3D vectors in Angstrom. Order is 1st vector (x,y,z), 2nd vector (x,y,z) and 3rd vector (x,y,z) 
    /// </summary>
    std::vector<float> getRotationCrystalLattice() const;
    void setRotationCrystalLattice(std::vector<float> const value);
    bool rotationCrystalLatticeIsSet() const;
    void unsetRotation_crystal_lattice();
    /// <summary>
    /// Bravais lattice type of the global rotation-indexing solution: crystal-system letter + centering, e.g. \&quot;tP\&quot;, \&quot;oC\&quot;, \&quot;cF\&quot;, \&quot;hR\&quot;, \&quot;mP\&quot;. Empty if not determined. 
    /// </summary>
    std::string getRotationBravais() const;
    void setRotationBravais(std::string const& value);
    bool rotationBravaisIsSet() const;
    void unsetRotation_bravais();
    /// <summary>
    /// 
    /// </summary>
    std::vector<org::openapitools::server::model::Scan_result_images_inner> getImages() const;
    void setImages(std::vector<org::openapitools::server::model::Scan_result_images_inner> const& value);

    friend  void to_json(nlohmann::json& j, const Scan_result& o);
    friend  void from_json(const nlohmann::json& j, Scan_result& o);
protected:
    std::string m_File_prefix;
    bool m_File_prefixIsSet;
    org::openapitools::server::model::Unit_cell m_Rotation_unit_cell;
    bool m_Rotation_unit_cellIsSet;
    std::vector<float> m_Rotation_crystal_lattice;
    bool m_Rotation_crystal_latticeIsSet;
    std::string m_Rotation_bravais;
    bool m_Rotation_bravaisIsSet;
    std::vector<org::openapitools::server::model::Scan_result_images_inner> m_Images;

    
};

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

#endif /* Scan_result_H_ */