#ifndef SPINNINGDISK_HPP_INCLUDED
#define SPINNINGDISK_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/ConfocalScanner_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 SpinningDisk.
*
* A Spinning disk confocal scanner is a device in which the scanning of the illuminated and detected spots is performed simultaneously using an opaque disk called a Nipkow disk, which has many ideally identical small holes arranged in Archimedean spirals. Refer to https://www.iso.org/standard/69820.html for further details and measurement methods.
*/
class NBO_EXPORT SpinningDisk : public ConfocalScanner_Type {

public:
	
	SpinningDisk();
	~SpinningDisk();

	/*!
	* \brief Cast a NBOBaseClass to a SpinningDisk.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<SpinningDisk> 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 SingleDisk attribute.
	*
	* This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setSingleDisk(const bool& value, bool validate = true);

	/*!
	* \brief Returns the value of the SingleDisk attribute.
	*
	* This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.
	*
	* \return The value of the attribute
	*/
	bool getSingleDisk() const;

	/*!
	* \brief Resets the SingleDisk attribute to an unset state.
	*
	* This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.
	*/
	void resetSingleDisk();

	/*!
	* \brief Checks whether the SingleDisk attribute is present.
	*
	* This records whether this Spinning Disk Confocal Scanner uses Single-Disk (True) or Dual-Disk (False) technology.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasSingleDisk() const;

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

	/*!
	* \brief Returns the value of the DiskSpeed attribute.
	*
	* This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.
	*
	* \return The value of the attribute
	*/
	float getDiskSpeed() const;

	/*!
	* \brief Resets the DiskSpeed attribute to an unset state.
	*
	* This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.
	*/
	void resetDiskSpeed();

	/*!
	* \brief Checks whether the DiskSpeed attribute is present.
	*
	* This field records the maximal Disk rotation Speed of this device, according to the Manufactuer.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasDiskSpeed() const;

	/*!
	* \brief Sets the value of the DiskSpeedUnit 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 setDiskSpeedUnit(const Inscoper::NBO::UnitsVelocity_TypePtr& value, bool validate = true);

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

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

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


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

    std::optional<bool> SingleDisk; // Optional attribute
    std::optional<float> DiskSpeed; // Optional attribute
	UnitsVelocity_TypePtr DiskSpeedUnit = nullptr; // Optional attribute
};

/*! Shared pointer for SpinningDisk*/
typedef std::shared_ptr<SpinningDisk> SpinningDiskPtr;

} // namespace Inscoper::NBO

#endif // SPINNINGDISK_HPP_INCLUDED