#ifndef LIGHTSOURCE_TYPE_HPP_INCLUDED
#define LIGHTSOURCE_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/LightSourceID_Type.h>
#include <NBO/NBO/LightSourceIlluminationPowerReportingPosition_Type.h>
#include <NBO/NBO/LightSourceIlluminationPowerReportingStatistic_Type.h>
#include <NBO/NBO/ManufacturerSpec_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 LightSource.
*
* This element describes one or more Light Source(s) available for this Instrument. An Instrument may have several Light Sources of different types (Laser, Light Emitting Diode, Filament, Arc etc.). A typical fluorescence Microscope has two Light Sources, one for Transmitted light and one for Fluorescence light.
*/
class NBO_EXPORT LightSource_Type : public ManufacturerSpec_Type {

public:
	
	LightSource_Type();
	~LightSource_Type();

	/*!
	* \brief Cast a NBOBaseClass to a LightSource_Type.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<LightSource_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::LightSourceID_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
	*/
	LightSourceID_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 PurchaseDate attribute.
	*
	* This field records the Date in which this Light Source was purchased.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setPurchaseDate(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the PurchaseDate attribute.
	*
	* This field records the Date in which this Light Source was purchased.
	*
	* \return The value of the attribute
	*/
	std::string getPurchaseDate() const;

	/*!
	* \brief Resets the PurchaseDate attribute to an unset state.
	*
	* This field records the Date in which this Light Source was purchased.
	*/
	void resetPurchaseDate();

	/*!
	* \brief Checks whether the PurchaseDate attribute is present.
	*
	* This field records the Date in which this Light Source was purchased.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasPurchaseDate() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* This field records the Date in which this Light Source was purchased.
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getPurchaseDateAllowedValues();

	/*!
	* \brief Sets the value of the IlluminationPowerReportingStatistic attribute.
	*
	* This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setIlluminationPowerReportingStatistic(const Inscoper::NBO::LightSourceIlluminationPowerReportingStatistic_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the IlluminationPowerReportingStatistic attribute.
	*
	* This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
	*
	* \return The value of the attribute
	*/
	LightSourceIlluminationPowerReportingStatistic_TypePtr getIlluminationPowerReportingStatistic() const;

	/*!
	* \brief Resets the IlluminationPowerReportingStatistic attribute to an unset state.
	*
	* This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
	*/
	void resetIlluminationPowerReportingStatistic();

	/*!
	* \brief Checks whether the optional IlluminationPowerReportingStatistic attribute is present.
	*
	* This field reports the statistic used by the Manufacturer to report the nominal Illumination Power output emitted by this Light Source at Peak Wavelength.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasIlluminationPowerReportingStatistic() const;

	/*!
	* \brief Sets the value of the IlluminationPowerReportingPosition attribute.
	*
	* This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setIlluminationPowerReportingPosition(const Inscoper::NBO::LightSourceIlluminationPowerReportingPosition_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the IlluminationPowerReportingPosition attribute.
	*
	* This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
	*
	* \return The value of the attribute
	*/
	LightSourceIlluminationPowerReportingPosition_TypePtr getIlluminationPowerReportingPosition() const;

	/*!
	* \brief Resets the IlluminationPowerReportingPosition attribute to an unset state.
	*
	* This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
	*/
	void resetIlluminationPowerReportingPosition();

	/*!
	* \brief Checks whether the optional IlluminationPowerReportingPosition attribute is present.
	*
	* This field records the Position where the reported Illumination Intensity value was obtained as reported by the Manufacturer.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasIlluminationPowerReportingPosition() const;

	/*!
	* \brief Sets the value of the AnnotationRef element.
	*
	* This is a simple multi-line comment or annotation describing this component.
	*
	* \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.
	*
	* This is a simple multi-line comment or annotation describing this component.
	*
	* \return The value of the element
	*/
	Inscoper::NBO::AnnotationRefPtr getAnnotationRef() const;

	/*!
	* \brief Resets the AnnotationRef element to an unset state.
	*
	* This is a simple multi-line comment or annotation describing this component.
	*/
	void resetAnnotationRef();

	/*!
	* \brief Checks whether the optional AnnotationRef element is present.
	*
	* This is a simple multi-line comment or annotation describing this component.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasAnnotationRef() const;


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

	LightSourceID_TypePtr ID = nullptr; // Required attribute
	Denomination_TypePtr Name = nullptr; // Optional attribute
    std::optional<std::string> PurchaseDate; // Optional attribute
    static const std::set<std::string> PurchaseDateAllowedValues;
	LightSourceIlluminationPowerReportingStatistic_TypePtr IlluminationPowerReportingStatistic = nullptr; // Optional attribute
	LightSourceIlluminationPowerReportingPosition_TypePtr IlluminationPowerReportingPosition = nullptr; // Optional attribute
    Inscoper::NBO::AnnotationRefPtr AnnotationRef = nullptr;
};

/*! Shared pointer for LightSource_Type*/
typedef std::shared_ptr<LightSource_Type> LightSource_TypePtr;

} // namespace Inscoper::NBO

#endif // LIGHTSOURCE_TYPE_HPP_INCLUDED