#ifndef ACOUSTOOPTICALMODULATOR_HPP_INCLUDED
#define ACOUSTOOPTICALMODULATOR_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/AOMType_Type.h>
#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 AcoustoOpticalModulator.
*
* An acousto-optic modulator (AOM) is an electronically-tunable device which can be used for controlling the direction and/or intensity of a laser beam by an acoustically-induced diffraction grating in a crystal. It is based on the acousto-optic effect, i.e. the modification of the refractive index of some crystal or glass material by the oscillating mechanical strain of a sound wave (photoelastic effect).
*/
class NBO_EXPORT AcoustoOpticalModulator : public AcoustoOpticalDevice_Type {

public:
	
	AcoustoOpticalModulator();
	~AcoustoOpticalModulator();

	/*!
	* \brief Cast a NBOBaseClass to a AcoustoOpticalModulator.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<AcoustoOpticalModulator> 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 Type attribute.
	*
	* This field describes the category of this device.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setType(const Inscoper::NBO::AOMType_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Type attribute.
	*
	* This field describes the category of this device.
	*
	* \return The value of the attribute
	*/
	AOMType_TypePtr getType() const;

	/*!
	* \brief Resets the Type attribute to an unset state.
	*
	* This field describes the category of this device.
	*/
	void resetType();

	/*!
	* \brief Checks whether the optional Type attribute is present.
	*
	* This field describes the category of this device.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasType() const;


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

	AOMType_TypePtr Type = nullptr; // Optional attribute
};

/*! Shared pointer for AcoustoOpticalModulator*/
typedef std::shared_ptr<AcoustoOpticalModulator> AcoustoOpticalModulatorPtr;

} // namespace Inscoper::NBO

#endif // ACOUSTOOPTICALMODULATOR_HPP_INCLUDED