#ifndef LIQUIDCRYSTALTUNEABLEFILTERSETTINGS_HPP_INCLUDED
#define LIQUIDCRYSTALTUNEABLEFILTERSETTINGS_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/ElectroOpticalDeviceSettings_Type.h>
#include <NBO/NBO/ENBOType.h>
#include <NBO/NBOGlobal.h>
#include <NBO/Shared/Base/NBOBaseClass.h>


namespace Inscoper::NBO {

/*!
* \brief Represents the XML element LiquidCrystalTuneableFilterSettings.
*
* This element holds the Setting applied to a Liquid Crystal Tunable Filter (LCTF) used during the Acquisition of this Channel as well as a reference (the ID attribute) to the LCTF in question.
*/
class NBO_EXPORT LiquidCrystalTuneableFilterSettings : public ElectroOpticalDeviceSettings_Type {

public:
	
	LiquidCrystalTuneableFilterSettings();
	~LiquidCrystalTuneableFilterSettings();

	/*!
	* \brief Cast a NBOBaseClass to a LiquidCrystalTuneableFilterSettings.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<LiquidCrystalTuneableFilterSettings> fromBase(NBOBaseClassPtr base);

	/*!
	* \brief Returns the class type name.
	*
	* \return The class type name
	*/
	std::string getTypeName() const override;

	/*!
	* \brief Returns the XML element name corresponding to this class.
	*
	* \return The XML element name
	*/
	std::string getXMLName() const override;

	/*!
	* \brief Returns the NBO Type corresponding to this class.
	*
	* \return The NBO Type value
	*/
	ENBOType getNBOType() const override;

	/*!
	* \brief Returns a list of all classes derived from this class.
	*
	* \return The list of derived classes
	*/
	std::vector<NBOBaseClassPtr> getChildren() const override;

	/*!
	* \brief Returns a list of all child elements contained in this class.
	*
	* \return The list of child classes
	*/
	std::vector<NBOBaseClassPtr> getSubElements() const override;

	/*!
	* \brief Populates this object from a JSON file.
	*
	* \param path The path to the JSON file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromJsonFile(const std::string& path, bool validate = true);

	/*!
	* \brief Populates this object from a JSON string.
	*
	* \param json_string The JSON content as a string
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromJsonString(const std::string& json_string, bool validate = true);

	/*!
	* \brief Populates this object from a XML file.
	*
	* \param path The path to the XML file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromXmlFile(const std::string& path, bool validate = true);

	/*!
	* \brief Populates this object from a XML string.
	*
	* \param xml_string The XML content as a string
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void fromXmlString(const std::string& xml_string, bool validate = true);

	/*!
	* \brief Serializes this object to an XML file.
	*
	* \param filename The path to the output XML file
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void toXmlFile(const std::string& filename, bool validate = true) const;

	/*!
	* \brief Serializes this object to an XML string.
	*
	* \param validate If true, validates constraints on value. Default is true.
	* \return A string containing the XML representation of this object
	*/
	std::string toXmlString(bool validate = true) const;

	/*!
	* \brief Sets the value of the PolarizationRotation attribute.
	*
	* A Pockels cell is a device consisting of an electro-optic crystal (with some electrodes attached to it) through which a light beam can propagate. The phase delay in the crystal (→ Pockels effect) can be modulated by applying a variable electric voltage. Alignment of the crystal axis with the light beam axis is critical. This field records the polarization rotation applied to the beam during the acquisition of this Channel.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setPolarizationRotation(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the PolarizationRotation attribute.
	*
	* A Pockels cell is a device consisting of an electro-optic crystal (with some electrodes attached to it) through which a light beam can propagate. The phase delay in the crystal (→ Pockels effect) can be modulated by applying a variable electric voltage. Alignment of the crystal axis with the light beam axis is critical. This field records the polarization rotation applied to the beam during the acquisition of this Channel.
	*
	* \return The value of the attribute
	*/
	float getPolarizationRotation() const;

	/*!
	* \brief Resets the PolarizationRotation attribute to an unset state.
	*
	* A Pockels cell is a device consisting of an electro-optic crystal (with some electrodes attached to it) through which a light beam can propagate. The phase delay in the crystal (→ Pockels effect) can be modulated by applying a variable electric voltage. Alignment of the crystal axis with the light beam axis is critical. This field records the polarization rotation applied to the beam during the acquisition of this Channel.
	*/
	void resetPolarizationRotation();

	/*!
	* \brief Checks whether the PolarizationRotation attribute is present.
	*
	* A Pockels cell is a device consisting of an electro-optic crystal (with some electrodes attached to it) through which a light beam can propagate. The phase delay in the crystal (→ Pockels effect) can be modulated by applying a variable electric voltage. Alignment of the crystal axis with the light beam axis is critical. This field records the polarization rotation applied to the beam during the acquisition of this Channel.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasPolarizationRotation() const;


private:
	class Impl;
	std::unique_ptr<Impl> pImpl;

    std::optional<float> PolarizationRotation; // Optional attribute
};

/*! Shared pointer for LiquidCrystalTuneableFilterSettings*/
typedef std::shared_ptr<LiquidCrystalTuneableFilterSettings> LiquidCrystalTuneableFilterSettingsPtr;

} // namespace Inscoper::NBO

#endif // LIQUIDCRYSTALTUNEABLEFILTERSETTINGS_HPP_INCLUDED