109 lines
4.2 KiB
C++
109 lines
4.2 KiB
C++
/**
|
|
* 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.91
|
|
* 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.
|
|
*/
|
|
/*
|
|
* Grid_scan.h
|
|
*
|
|
* Definition of a grid scan (mutually exclusive with `rotation_axis`)
|
|
*/
|
|
|
|
#ifndef Grid_scan_H_
|
|
#define Grid_scan_H_
|
|
|
|
|
|
#include <nlohmann/json.hpp>
|
|
|
|
namespace org::openapitools::server::model
|
|
{
|
|
|
|
/// <summary>
|
|
/// Definition of a grid scan (mutually exclusive with `rotation_axis`)
|
|
/// </summary>
|
|
class Grid_scan
|
|
{
|
|
public:
|
|
Grid_scan();
|
|
virtual ~Grid_scan() = 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 Grid_scan& rhs) const;
|
|
bool operator!=(const Grid_scan& rhs) const;
|
|
|
|
/////////////////////////////////////////////
|
|
/// Grid_scan members
|
|
|
|
/// <summary>
|
|
/// Number of elements in the fast direction
|
|
/// </summary>
|
|
int64_t getNFast() const;
|
|
void setNFast(int64_t const value);
|
|
/// <summary>
|
|
/// Step in grid along the fast direction. Can be negative. Positive number: left to right Negative number: right to left
|
|
/// </summary>
|
|
float getStepXUm() const;
|
|
void setStepXUm(float const value);
|
|
/// <summary>
|
|
/// Step in grid along the slow direction. Can be negative. Positive number: top to bottom Negative number: bottom to top
|
|
/// </summary>
|
|
float getStepYUm() const;
|
|
void setStepYUm(float const value);
|
|
/// <summary>
|
|
/// If disabled: fast direction = X, slow direction = Y If enabled: fast direction = Y, slow direction = X
|
|
/// </summary>
|
|
bool isVertical() const;
|
|
void setVertical(bool const value);
|
|
bool verticalIsSet() const;
|
|
void unsetVertical();
|
|
/// <summary>
|
|
/// Flip fast direction for every second row
|
|
/// </summary>
|
|
bool isSnake() const;
|
|
void setSnake(bool const value);
|
|
bool snakeIsSet() const;
|
|
void unsetSnake();
|
|
|
|
friend void to_json(nlohmann::json& j, const Grid_scan& o);
|
|
friend void from_json(const nlohmann::json& j, Grid_scan& o);
|
|
protected:
|
|
int64_t m_N_fast;
|
|
|
|
float m_Step_x_um;
|
|
|
|
float m_Step_y_um;
|
|
|
|
bool m_Vertical;
|
|
bool m_VerticalIsSet;
|
|
bool m_Snake;
|
|
bool m_SnakeIsSet;
|
|
|
|
};
|
|
|
|
} // namespace org::openapitools::server::model
|
|
|
|
#endif /* Grid_scan_H_ */
|