#ifndef ACOUSTOOPTICALTUNEABLEFILTER_HPP_INCLUDED
#define ACOUSTOOPTICALTUNEABLEFILTER_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/AcoustoOpticalDevice_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 AcoustoOpticalTuneableFilter.
*
* This is kind tuneable filter, whose optical filtering properties can be tuned by virtue of acousto-optical deflection. As such, different wavelengths exits the crystal at different angles depending on the applied radio wave frequency. In an optical system in which the input light beam strikes the crystal at a specific angle and can only re-enter the system at a specific angle, then one can choose the wavelength of the light diffracted at the output angle angle by varying the frequency of the acoustic wave.
*/
class NBO_EXPORT AcoustoOpticalTuneableFilter : public AcoustoOpticalDevice_Type {

public:
	AcoustoOpticalTuneableFilter();
	~AcoustoOpticalTuneableFilter();

	/*!
	* \brief Cast a NBOBaseClass to a AcoustoOpticalTuneableFilter.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<AcoustoOpticalTuneableFilter> 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;


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

/*! Shared pointer for AcoustoOpticalTuneableFilter*/
typedef std::shared_ptr<AcoustoOpticalTuneableFilter> AcoustoOpticalTuneableFilterPtr;

} // namespace Inscoper::NBO

#endif // ACOUSTOOPTICALTUNEABLEFILTER_HPP_INCLUDED