#ifndef OPTICALAPERTURE_TYPE_HPP_INCLUDED
#define OPTICALAPERTURE_TYPE_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/AnnotationRef.h>
#include <NBO/NBO/Denomination_Type.h>
#include <NBO/NBO/LensID_Type.h>
#include <NBO/NBO/ManufacturerSpec_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 complex type OpticalAperture.
*
* This element represents any mechanical, non optical device that is placed in the Light Path and spatially modifies the light beam. Examples include, Pin Holes, Phase Rings, Dark Field Stops, Hoffman Modulators, Diffraction Gratings etc. This element can be associated with an optional Optics Turret.
*/
class NBO_EXPORT OpticalAperture_Type : public ManufacturerSpec_Type {

public:
	
	OpticalAperture_Type();
	~OpticalAperture_Type();

	/*!
	* \brief Cast a NBOBaseClass to a OpticalAperture_Type.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<OpticalAperture_Type> fromBase(NBOBaseClassPtr base);

	/*!
	* \brief Returns the class type name.
	*
	* \return The class type name
	*/
	virtual 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 ID attribute.
	*
	* A Unique Identifier for this component.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setID(const Inscoper::NBO::LensID_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the ID attribute.
	*
	* A Unique Identifier for this component.
	*
	* \return The value of the attribute
	*/
	LensID_TypePtr getID() const;

	/*!
	* \brief Resets the ID attribute to an unset state.
	*
	* A Unique Identifier for this component.
	*/
	void resetID();

	/*!
	* \brief Checks whether the optional ID attribute is present.
	*
	* A Unique Identifier for this component.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasID() const;

	/*!
	* \brief Sets the value of the Name attribute.
	*
	* A User-defined Name for this component.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setName(const Inscoper::NBO::Denomination_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Name attribute.
	*
	* A User-defined Name for this component.
	*
	* \return The value of the attribute
	*/
	Denomination_TypePtr getName() const;

	/*!
	* \brief Resets the Name attribute to an unset state.
	*
	* A User-defined Name for this component.
	*/
	void resetName();

	/*!
	* \brief Checks whether the optional Name attribute is present.
	*
	* A User-defined Name for this component.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasName() const;

	/*!
	* \brief Sets the value of the OpticsHolderPosition attribute.
	*
	* This field records the position of this Optical Aperture in a Optics Turret.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setOpticsHolderPosition(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the OpticsHolderPosition attribute.
	*
	* This field records the position of this Optical Aperture in a Optics Turret.
	*
	* \return The value of the attribute
	*/
	std::string getOpticsHolderPosition() const;

	/*!
	* \brief Resets the OpticsHolderPosition attribute to an unset state.
	*
	* This field records the position of this Optical Aperture in a Optics Turret.
	*/
	void resetOpticsHolderPosition();

	/*!
	* \brief Checks whether the OpticsHolderPosition attribute is present.
	*
	* This field records the position of this Optical Aperture in a Optics Turret.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasOpticsHolderPosition() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* This field records the position of this Optical Aperture in a Optics Turret.
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getOpticsHolderPositionAllowedValues();

	/*!
	* \brief Sets the value of the OuterDiameter attribute.
	*
	* This field captures the physical outer diameter of the component
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setOuterDiameter(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the OuterDiameter attribute.
	*
	* This field captures the physical outer diameter of the component
	*
	* \return The value of the attribute
	*/
	float getOuterDiameter() const;

	/*!
	* \brief Resets the OuterDiameter attribute to an unset state.
	*
	* This field captures the physical outer diameter of the component
	*/
	void resetOuterDiameter();

	/*!
	* \brief Checks whether the OuterDiameter attribute is present.
	*
	* This field captures the physical outer diameter of the component
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasOuterDiameter() const;

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

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

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

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

	/*!
	* \brief Sets the value of the AnnotationRef element.
	*
	* 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 setAnnotationRef(const Inscoper::NBO::AnnotationRefPtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the AnnotationRef element.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the element
	*/
	Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const;

	/*!
	* \brief Resets the AnnotationRef element to an unset state.
	*
	* No description available in the XSD standard.
	*/
	void resetAnnotationRef();

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


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

	LensID_TypePtr ID = nullptr; // Required attribute
	Denomination_TypePtr Name = nullptr; // Optional attribute
    std::optional<std::string> OpticsHolderPosition; // Optional attribute
    static const std::set<std::string> OpticsHolderPositionAllowedValues;
    std::optional<float> OuterDiameter; // Optional attribute
	UnitsLength_TypePtr OuterDiameterUnit = nullptr; // Optional attribute
    Inscoper::NBO::AnnotationRefPtr AnnotationRef = nullptr;
};

/*! Shared pointer for OpticalAperture_Type*/
typedef std::shared_ptr<OpticalAperture_Type> OpticalAperture_TypePtr;

} // namespace Inscoper::NBO

#endif // OPTICALAPERTURE_TYPE_HPP_INCLUDED