#ifndef FLUOROPHORE_HPP_INCLUDED
#define FLUOROPHORE_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/Denomination_Type.h>
#include <NBO/NBO/FluorescentLabelType_Type.h>
#include <NBO/NBO/LSID_Type.h>
#include <NBO/NBO/ManufacturerSpec_Type.h>
#include <NBO/NBO/PositiveFloat_Type.h>
#include <NBO/NBO/UnitsConcentration_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 Fluorophore.
*
* This element describes the Fluorophore whose Emission is used to produce this Channel. [plain text string].
*/
class NBO_EXPORT Fluorophore : public ManufacturerSpec_Type {

public:
	
	Fluorophore();
	~Fluorophore();

	/*!
	* \brief Cast a NBOBaseClass to a Fluorophore.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<Fluorophore> 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 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::LSID_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
	*/
	LSID_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.
	*
	* This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.
	*
	* \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.
	*
	* This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.
	*
	* \return The value of the attribute
	*/
	Denomination_TypePtr getName() const;

	/*!
	* \brief Resets the Name attribute to an unset state.
	*
	* This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.
	*/
	void resetName();

	/*!
	* \brief Checks whether the optional Name attribute is present.
	*
	* This field records a descriptive term that designates this Fluorophore as specified by the Manufacturer. For example, it might be the name of a specific Fluorescence Protein variant, or the name used by the Manufactuer for an organic dye.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasName() const;

	/*!
	* \brief Sets the value of the Type attribute.
	*
	* This field records a term that describes the general category of the Fluorescent Label used in this case.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setType(const Inscoper::NBO::FluorescentLabelType_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Type attribute.
	*
	* This field records a term that describes the general category of the Fluorescent Label used in this case.
	*
	* \return The value of the attribute
	*/
	FluorescentLabelType_TypePtr getType() const;

	/*!
	* \brief Resets the Type attribute to an unset state.
	*
	* This field records a term that describes the general category of the Fluorescent Label used in this case.
	*/
	void resetType();

	/*!
	* \brief Checks whether the optional Type attribute is present.
	*
	* This field records a term that describes the general category of the Fluorescent Label used in this case.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasType() const;

	/*!
	* \brief Sets the value of the ExcitationWavelength attribute.
	*
	* This field records the Excitation Wavelength used for this Channel.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setExcitationWavelength(const Inscoper::NBO::PositiveFloat_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the ExcitationWavelength attribute.
	*
	* This field records the Excitation Wavelength used for this Channel.
	*
	* \return The value of the attribute
	*/
	PositiveFloat_TypePtr getExcitationWavelength() const;

	/*!
	* \brief Resets the ExcitationWavelength attribute to an unset state.
	*
	* This field records the Excitation Wavelength used for this Channel.
	*/
	void resetExcitationWavelength();

	/*!
	* \brief Checks whether the optional ExcitationWavelength attribute is present.
	*
	* This field records the Excitation Wavelength used for this Channel.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasExcitationWavelength() const;

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

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

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

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

	/*!
	* \brief Sets the value of the EmissionWavelength attribute.
	*
	* This field records the Emission Wavelength used for this Channel.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setEmissionWavelength(const Inscoper::NBO::PositiveFloat_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the EmissionWavelength attribute.
	*
	* This field records the Emission Wavelength used for this Channel.
	*
	* \return The value of the attribute
	*/
	PositiveFloat_TypePtr getEmissionWavelength() const;

	/*!
	* \brief Resets the EmissionWavelength attribute to an unset state.
	*
	* This field records the Emission Wavelength used for this Channel.
	*/
	void resetEmissionWavelength();

	/*!
	* \brief Checks whether the optional EmissionWavelength attribute is present.
	*
	* This field records the Emission Wavelength used for this Channel.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasEmissionWavelength() const;

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

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

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

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

	/*!
	* \brief Sets the value of the Concentration attribute.
	*
	* If applicable (e.g., in the case of direct incubation of the sample  with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setConcentration(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the Concentration attribute.
	*
	* If applicable (e.g., in the case of direct incubation of the sample  with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.
	*
	* \return The value of the attribute
	*/
	float getConcentration() const;

	/*!
	* \brief Resets the Concentration attribute to an unset state.
	*
	* If applicable (e.g., in the case of direct incubation of the sample  with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.
	*/
	void resetConcentration();

	/*!
	* \brief Checks whether the Concentration attribute is present.
	*
	* If applicable (e.g., in the case of direct incubation of the sample  with a specific label such as DAPI or Mitotracker Red), this field records the Concentration of this Fluorophore that was used to stain the Sample and that was imaged in this Channel.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasConcentration() const;

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

	/*!
	* \brief Returns the value of the ConcentrationUnit attribute.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the attribute
	*/
	UnitsConcentration_TypePtr getConcentrationUnit() const;

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

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

	/*!
	* \brief Sets the value of the FBBaseID attribute.
	*
	* In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setFBBaseID(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the FBBaseID attribute.
	*
	* In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).
	*
	* \return The value of the attribute
	*/
	std::string getFBBaseID() const;

	/*!
	* \brief Resets the FBBaseID attribute to an unset state.
	*
	* In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).
	*/
	void resetFBBaseID();

	/*!
	* \brief Checks whether the FBBaseID attribute is present.
	*
	* In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasFBBaseID() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* In case the Fluorophore is a Fluorescent Protein, this field records its FPBaseID (FPBase.org).
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getFBBaseIDAllowedValues();

	/*!
	* \brief Sets the value of the PrimaryPublicationID attribute.
	*
	* This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setPrimaryPublicationID(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the PrimaryPublicationID attribute.
	*
	* This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.
	*
	* \return The value of the attribute
	*/
	std::string getPrimaryPublicationID() const;

	/*!
	* \brief Resets the PrimaryPublicationID attribute to an unset state.
	*
	* This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.
	*/
	void resetPrimaryPublicationID();

	/*!
	* \brief Checks whether the PrimaryPublicationID attribute is present.
	*
	* This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasPrimaryPublicationID() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* This field captures the a Unique Identifier for the Primary Publication describing this Fluorescent Label. Examples include, Digital Object Identifier (DOI), PubMed Central Identifier (PMCID), ArXiv.org ID etc.
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getPrimaryPublicationIDAllowedValues();


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

	LSID_TypePtr ID = nullptr; // Required attribute
	Denomination_TypePtr Name = nullptr; // Optional attribute
	FluorescentLabelType_TypePtr Type = nullptr; // Optional attribute
	PositiveFloat_TypePtr ExcitationWavelength = nullptr; // Optional attribute
	UnitsLength_TypePtr ExcitationWavelengthUnit = nullptr; // Optional attribute
	PositiveFloat_TypePtr EmissionWavelength = nullptr; // Optional attribute
	UnitsLength_TypePtr EmissionWavelengthUnit = nullptr; // Optional attribute
    std::optional<float> Concentration; // Optional attribute
	UnitsConcentration_TypePtr ConcentrationUnit = nullptr; // Optional attribute
    std::optional<std::string> FBBaseID; // Optional attribute
    static const std::set<std::string> FBBaseIDAllowedValues;
    std::optional<std::string> PrimaryPublicationID; // Optional attribute
    static const std::set<std::string> PrimaryPublicationIDAllowedValues;
};

/*! Shared pointer for Fluorophore*/
typedef std::shared_ptr<Fluorophore> FluorophorePtr;

} // namespace Inscoper::NBO

#endif // FLUOROPHORE_HPP_INCLUDED