#ifndef IRISDIAPHRAGM_HPP_INCLUDED
#define IRISDIAPHRAGM_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/IrisShape_Type.h>
#include <NBO/NBO/OpticalAperture_Type.h>
#include <NBO/NBO/UnitsLength_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 IrisDiaphragm.
*
* This element represents a Diaphragm, positioned trasversally to the optical axis bounded by multiple leaves, usually metal, arranged so as to provide an opening of variable size, which is adjustable by means of a mechanical control.
*/
class NBO_EXPORT IrisDiaphragm : public OpticalAperture_Type {

public:
	
	IrisDiaphragm();
	~IrisDiaphragm();

	/*!
	* \brief Cast a NBOBaseClass to a IrisDiaphragm.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<IrisDiaphragm> 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 MaxApertureDiameter attribute.
	*
	* This field records the Maximum physical Diameter of the Aperture of this Iris Diaphragm.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setMaxApertureDiameter(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the MaxApertureDiameter attribute.
	*
	* This field records the Maximum physical Diameter of the Aperture of this Iris Diaphragm.
	*
	* \return The value of the attribute
	*/
	float getMaxApertureDiameter() const;

	/*!
	* \brief Resets the MaxApertureDiameter attribute to an unset state.
	*
	* This field records the Maximum physical Diameter of the Aperture of this Iris Diaphragm.
	*/
	void resetMaxApertureDiameter();

	/*!
	* \brief Checks whether the MaxApertureDiameter attribute is present.
	*
	* This field records the Maximum physical Diameter of the Aperture of this Iris Diaphragm.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasMaxApertureDiameter() const;

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

	/*!
	* \brief Returns the value of the MaxApertureDiameterUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the attribute
	*/
	UnitsLength_TypePtr getMaxApertureDiameterUnit() const;

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

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

	/*!
	* \brief Sets the value of the Shape attribute.
	*
	* This field captures the Shape of the aperture of this Iris Diaphragm.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setShape(const Inscoper::NBO::IrisShape_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Shape attribute.
	*
	* This field captures the Shape of the aperture of this Iris Diaphragm.
	*
	* \return The value of the attribute
	*/
	IrisShape_TypePtr getShape() const;

	/*!
	* \brief Resets the Shape attribute to an unset state.
	*
	* This field captures the Shape of the aperture of this Iris Diaphragm.
	*/
	void resetShape();

	/*!
	* \brief Checks whether the optional Shape attribute is present.
	*
	* This field captures the Shape of the aperture of this Iris Diaphragm.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasShape() const;


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

    std::optional<float> MaxApertureDiameter; // Optional attribute
	UnitsLength_TypePtr MaxApertureDiameterUnit = nullptr; // Optional attribute
	IrisShape_TypePtr Shape = nullptr; // Optional attribute
};

/*! Shared pointer for IrisDiaphragm*/
typedef std::shared_ptr<IrisDiaphragm> IrisDiaphragmPtr;

} // namespace Inscoper::NBO

#endif // IRISDIAPHRAGM_HPP_INCLUDED