Files
Jungfraujoch/broker/gen/model/File_writer_format.h
Filip Leonarski fb75899789
Some checks failed
Build Packages / build:rpm (ubuntu2404_nocuda) (push) Failing after 10m57s
Build Packages / build:rpm (ubuntu2204_nocuda) (push) Failing after 12m25s
Build Packages / build:rpm (rocky8_nocuda) (push) Successful in 12m35s
Build Packages / build:rpm (ubuntu2204) (push) Failing after 12m33s
Build Packages / Generate python client (push) Successful in 18s
Build Packages / Create release (push) Has been skipped
Build Packages / build:rpm (rocky8) (push) Successful in 12m40s
Build Packages / build:rpm (rocky8_sls9) (push) Successful in 13m1s
Build Packages / Build documentation (push) Successful in 35s
Build Packages / build:rpm (rocky9_nocuda) (push) Successful in 13m27s
Build Packages / build:rpm (rocky9) (push) Successful in 13m51s
Build Packages / build:rpm (ubuntu2404) (push) Failing after 6m48s
Build Packages / Unit tests (push) Has been cancelled
VERSION: 1.0.0-rc.122
2025-12-16 11:42:05 +01:00

84 lines
4.0 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.122
* 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.
*/
/*
* File_writer_format.h
*
* None - no master file written NXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia NXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling
*/
#ifndef File_writer_format_H_
#define File_writer_format_H_
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
/// None - no master file written NXmxLegacy - legacy format with soft links to data files in the master file; necessary for DECTRIS Albula 4.0 and DECTRIS Neggia NXmxVDS - newer format with virtual dataset linking data files in the master file, also includes better metadata handling
/// </summary>
class File_writer_format
{
public:
File_writer_format();
virtual ~File_writer_format() = default;
enum class eFile_writer_format {
// To have a valid default value.
// Avoiding name clashes with user defined
// enum values
INVALID_VALUE_OPENAPI_GENERATED = 0,
NONE,
NXMXLEGACY,
NXMXVDS,
CBF,
TIFF,
NOFILEWRITTEN
};
/// <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 File_writer_format& rhs) const;
bool operator!=(const File_writer_format& rhs) const;
/////////////////////////////////////////////
/// File_writer_format members
File_writer_format::eFile_writer_format getValue() const;
void setValue(File_writer_format::eFile_writer_format value);
friend void to_json(nlohmann::json& j, const File_writer_format& o);
friend void from_json(const nlohmann::json& j, File_writer_format& o);
protected:
File_writer_format::eFile_writer_format m_value = File_writer_format::eFile_writer_format::INVALID_VALUE_OPENAPI_GENERATED;
};
} // namespace org::openapitools::server::model
#endif /* File_writer_format_H_ */