Files
Jungfraujoch/broker/gen/model/File_writer_settings.h
2025-07-03 15:10:04 +02:00

89 lines
2.6 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.
*
* The version of the OpenAPI document: 1.0.0-rc.58
* 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_settings.h
*
*
*/
#ifndef File_writer_settings_H_
#define File_writer_settings_H_
#include "File_writer_format.h"
#include <nlohmann/json.hpp>
namespace org::openapitools::server::model
{
/// <summary>
///
/// </summary>
class File_writer_settings
{
public:
File_writer_settings();
virtual ~File_writer_settings() = 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 File_writer_settings& rhs) const;
bool operator!=(const File_writer_settings& rhs) const;
/////////////////////////////////////////////
/// File_writer_settings members
/// <summary>
/// Inform jfjoch_write to overwrite existing files. Otherwise files would be saved with .h5.{timestamp}.tmp suffix.
/// </summary>
bool isOverwrite() const;
void setOverwrite(bool const value);
bool overwriteIsSet() const;
void unsetOverwrite();
/// <summary>
///
/// </summary>
org::openapitools::server::model::File_writer_format getFormat() const;
void setFormat(org::openapitools::server::model::File_writer_format const& value);
bool formatIsSet() const;
void unsetFormat();
friend void to_json(nlohmann::json& j, const File_writer_settings& o);
friend void from_json(const nlohmann::json& j, File_writer_settings& o);
protected:
bool m_Overwrite;
bool m_OverwriteIsSet;
org::openapitools::server::model::File_writer_format m_Format;
bool m_FormatIsSet;
};
} // namespace org::openapitools::server::model
#endif /* File_writer_settings_H_ */