#ifndef GENERICEXCITATIONSOURCE_HPP_INCLUDED
#define GENERICEXCITATIONSOURCE_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/IlluminationWavelengthRange.h>
#include <NBO/NBO/LightSource_Type.h>
#include <NBO/NBO/Map_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 GenericExcitationSource.
*
* The GenericExcitationSource element is used to represent a light source as a collection of key/value pairs, stored in a Map. One of the other light source elements should always be used in preference to this if possible.
*/
class NBO_EXPORT GenericExcitationSource : public LightSource_Type {

public:
	
	GenericExcitationSource();
	~GenericExcitationSource();

	/*!
	* \brief Cast a NBOBaseClass to a GenericExcitationSource.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<GenericExcitationSource> 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 list of IlluminationWavelengthRange elements.
	*
	* No description available in the XSD standard.
	*
	* \param value The new list of IlluminationWavelengthRange elements
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setIlluminationWavelengthRange_List(const std::vector<Inscoper::NBO::IlluminationWavelengthRangePtr>& value, bool validate = true);

	/*!
	* \brief Returns the list of IlluminationWavelengthRange elements.
	*
	* No description available in the XSD standard.
	*
	* \return The list of IlluminationWavelengthRange elements
	*/
	std::vector<Inscoper::NBO::IlluminationWavelengthRangePtr> getIlluminationWavelengthRange_List() const;

	/*!
	* \brief Adds a new IlluminationWavelengthRange element to this object.
	*
	* No description available in the XSD standard.
	*
	* \param value The element to add
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void addToIlluminationWavelengthRange_List(const Inscoper::NBO::IlluminationWavelengthRangePtr& value, bool validate = true);

	/*!
	* \brief Clear the list of IlluminationWavelengthRange.
	*
	* No description available in the XSD standard.
	*/
	void clearIlluminationWavelengthRange_List();

	/*!
	* \brief Sets the value of the Map element.
	*
	* This is a Mapping of key/value pairs used to store customized metadata that describes this element.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setMap(const Inscoper::NBO::Map_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Map element.
	*
	* This is a Mapping of key/value pairs used to store customized metadata that describes this element.
	*
	* \return The value of the element
	*/
	Inscoper::NBO::Map_TypePtr getMap() const;

	/*!
	* \brief Resets the Map element to an unset state.
	*
	* This is a Mapping of key/value pairs used to store customized metadata that describes this element.
	*/
	void resetMap();

	/*!
	* \brief Checks whether the optional Map element is present.
	*
	* This is a Mapping of key/value pairs used to store customized metadata that describes this element.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasMap() const;


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

    std::vector<Inscoper::NBO::IlluminationWavelengthRangePtr> IlluminationWavelengthRange_List;
    Inscoper::NBO::Map_TypePtr Map = nullptr;
};

/*! Shared pointer for GenericExcitationSource*/
typedef std::shared_ptr<GenericExcitationSource> GenericExcitationSourcePtr;

} // namespace Inscoper::NBO

#endif // GENERICEXCITATIONSOURCE_HPP_INCLUDED