#ifndef PHOTODIODE_HPP_INCLUDED
#define PHOTODIODE_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/PointDetector_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 PhotoDiode.
*
* This element represents a Photovoltaic Detector. Most photodiodes used in confocal microscopes are Avalanche Photodiode (APD) which because of the amplification gain have good sensitivities and less dark current.
*/
class NBO_EXPORT PhotoDiode : public PointDetector_Type {

public:
	
	PhotoDiode();
	~PhotoDiode();

	/*!
	* \brief Cast a NBOBaseClass to a PhotoDiode.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<PhotoDiode> 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 Avalanche attribute.
	*
	* This field records whether (True) or not (False) this is an Avalanche Photodiode.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setAvalanche(const bool& value, bool validate = true);

	/*!
	* \brief Returns the value of the Avalanche attribute.
	*
	* This field records whether (True) or not (False) this is an Avalanche Photodiode.
	*
	* \return The value of the attribute
	*/
	bool getAvalanche() const;

	/*!
	* \brief Resets the Avalanche attribute to an unset state.
	*
	* This field records whether (True) or not (False) this is an Avalanche Photodiode.
	*/
	void resetAvalanche();

	/*!
	* \brief Checks whether the Avalanche attribute is present.
	*
	* This field records whether (True) or not (False) this is an Avalanche Photodiode.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasAvalanche() const;

	/*!
	* \brief Sets the value of the PINJunction attribute.
	*
	* This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setPINJunction(const bool& value, bool validate = true);

	/*!
	* \brief Returns the value of the PINJunction attribute.
	*
	* This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.
	*
	* \return The value of the attribute
	*/
	bool getPINJunction() const;

	/*!
	* \brief Resets the PINJunction attribute to an unset state.
	*
	* This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.
	*/
	void resetPINJunction();

	/*!
	* \brief Checks whether the PINJunction attribute is present.
	*
	* This field records whether this photodiode is based on a Positive-Intermediate-Negative (PIN) or a Positive-Negative (PN) architecture.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasPINJunction() const;


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

    std::optional<bool> Avalanche; // Optional attribute
    std::optional<bool> PINJunction; // Optional attribute
};

/*! Shared pointer for PhotoDiode*/
typedef std::shared_ptr<PhotoDiode> PhotoDiodePtr;

} // namespace Inscoper::NBO

#endif // PHOTODIODE_HPP_INCLUDED