#ifndef DARKFIELDSTOP_HPP_INCLUDED
#define DARKFIELDSTOP_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#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 DarkFieldStop.
*
* This element refers to a central circular stop (i.e., opaque disk) usually used in dark-field microscopy and placed in the front focal Plane of a Condenser to occlude all the direct light which would fall within the aperture of the objective.
*/
class NBO_EXPORT DarkFieldStop : public OpticalAperture_Type {

public:
	
	DarkFieldStop();
	~DarkFieldStop();

	/*!
	* \brief Cast a NBOBaseClass to a DarkFieldStop.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<DarkFieldStop> 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 CenterStopDiameter attribute.
	*
	* This field captures the physical diameter of the central disk of this Dark Field Stop.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setCenterStopDiameter(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the CenterStopDiameter attribute.
	*
	* This field captures the physical diameter of the central disk of this Dark Field Stop.
	*
	* \return The value of the attribute
	*/
	float getCenterStopDiameter() const;

	/*!
	* \brief Resets the CenterStopDiameter attribute to an unset state.
	*
	* This field captures the physical diameter of the central disk of this Dark Field Stop.
	*/
	void resetCenterStopDiameter();

	/*!
	* \brief Checks whether the CenterStopDiameter attribute is present.
	*
	* This field captures the physical diameter of the central disk of this Dark Field Stop.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasCenterStopDiameter() const;

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

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

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

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


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

    std::optional<float> CenterStopDiameter; // Optional attribute
	UnitsLength_TypePtr CenterStopDiameterUnit = nullptr; // Optional attribute
};

/*! Shared pointer for DarkFieldStop*/
typedef std::shared_ptr<DarkFieldStop> DarkFieldStopPtr;

} // namespace Inscoper::NBO

#endif // DARKFIELDSTOP_HPP_INCLUDED