#ifndef RASTERSCANNER_HPP_INCLUDED
#define RASTERSCANNER_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/ConfocalScanner_Type.h>
#include <NBO/NBO/RasterScannerType_Type.h>
#include <NBO/NBO/UnitsVelocity_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 RasterScanner.
*
* A Raster Scanner is typically used for systematic periodic scanning (raster scanning) of the Laser beam or of the Specimen position, either in one or in two dimensions. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.
*/
class NBO_EXPORT RasterScanner : public ConfocalScanner_Type {

public:
	
	RasterScanner();
	~RasterScanner();

	/*!
	* \brief Cast a NBOBaseClass to a RasterScanner.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<RasterScanner> 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 records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setType(const Inscoper::NBO::RasterScannerType_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Type attribute.
	*
	* This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
	*
	* \return The value of the attribute
	*/
	RasterScannerType_TypePtr getType() const;

	/*!
	* \brief Resets the Type attribute to an unset state.
	*
	* This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
	*/
	void resetType();

	/*!
	* \brief Checks whether the optional Type attribute is present.
	*
	* This field records the type of this Raster Scanner. In a Galvanometer-mirror based system, two galvanometer scan mirrors (one for each axis) direct the laser beam to any XY position in the field of view. In a Resonant system laser positioning in the x-axis is provided by a special resonant scan mirror which oscillates at a fixed frequency.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasType() const;

	/*!
	* \brief Sets the value of the HorizontalScanningSpeed attribute.
	*
	* This field records the maximal Horizontal Scanning Speed of this device.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setHorizontalScanningSpeed(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the HorizontalScanningSpeed attribute.
	*
	* This field records the maximal Horizontal Scanning Speed of this device.
	*
	* \return The value of the attribute
	*/
	float getHorizontalScanningSpeed() const;

	/*!
	* \brief Resets the HorizontalScanningSpeed attribute to an unset state.
	*
	* This field records the maximal Horizontal Scanning Speed of this device.
	*/
	void resetHorizontalScanningSpeed();

	/*!
	* \brief Checks whether the HorizontalScanningSpeed attribute is present.
	*
	* This field records the maximal Horizontal Scanning Speed of this device.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasHorizontalScanningSpeed() const;

	/*!
	* \brief Sets the value of the HorizontalScanningSpeedUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setHorizontalScanningSpeedUnit(const Inscoper::NBO::UnitsVelocity_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the HorizontalScanningSpeedUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the attribute
	*/
	UnitsVelocity_TypePtr getHorizontalScanningSpeedUnit() const;

	/*!
	* \brief Resets the HorizontalScanningSpeedUnit attribute to an unset state.
	*
	* No description available in the XSD standard.
	*/
	void resetHorizontalScanningSpeedUnit();

	/*!
	* \brief Checks whether the optional HorizontalScanningSpeedUnit attribute is present.
	*
	* No description available in the XSD standard.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasHorizontalScanningSpeedUnit() const;

	/*!
	* \brief Sets the value of the VerticalScanningSpeed attribute.
	*
	* This field records the maximal Vertical Scanning Speed of this device.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setVerticalScanningSpeed(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the VerticalScanningSpeed attribute.
	*
	* This field records the maximal Vertical Scanning Speed of this device.
	*
	* \return The value of the attribute
	*/
	float getVerticalScanningSpeed() const;

	/*!
	* \brief Resets the VerticalScanningSpeed attribute to an unset state.
	*
	* This field records the maximal Vertical Scanning Speed of this device.
	*/
	void resetVerticalScanningSpeed();

	/*!
	* \brief Checks whether the VerticalScanningSpeed attribute is present.
	*
	* This field records the maximal Vertical Scanning Speed of this device.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasVerticalScanningSpeed() const;

	/*!
	* \brief Sets the value of the VerticalScanningSpeedUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setVerticalScanningSpeedUnit(const Inscoper::NBO::UnitsVelocity_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the VerticalScanningSpeedUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the attribute
	*/
	UnitsVelocity_TypePtr getVerticalScanningSpeedUnit() const;

	/*!
	* \brief Resets the VerticalScanningSpeedUnit attribute to an unset state.
	*
	* No description available in the XSD standard.
	*/
	void resetVerticalScanningSpeedUnit();

	/*!
	* \brief Checks whether the optional VerticalScanningSpeedUnit attribute is present.
	*
	* No description available in the XSD standard.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasVerticalScanningSpeedUnit() const;


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

	RasterScannerType_TypePtr Type = nullptr; // Required attribute
    std::optional<float> HorizontalScanningSpeed; // Optional attribute
	UnitsVelocity_TypePtr HorizontalScanningSpeedUnit = nullptr; // Optional attribute
    std::optional<float> VerticalScanningSpeed; // Optional attribute
	UnitsVelocity_TypePtr VerticalScanningSpeedUnit = nullptr; // Optional attribute
};

/*! Shared pointer for RasterScanner*/
typedef std::shared_ptr<RasterScanner> RasterScannerPtr;

} // namespace Inscoper::NBO

#endif // RASTERSCANNER_HPP_INCLUDED