#ifndef COLOREDBEADS_HPP_INCLUDED
#define COLOREDBEADS_HPP_INCLUDED

#include <iostream>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include <NBO/NBO/BeadType_Type.h>
#include <NBO/NBO/LSID_Type.h>
#include <NBO/NBO/ManufacturerSpec_Type.h>
#include <NBO/NBO/UnitsConcentration_Type.h>
#include <NBO/NBO/UnitsLength_Type.h>
#include <NBO/NBO/WavelengthRange.h>
#include <NBO/NBO/ENBOType.h>
#include <NBO/NBOGlobal.h>
#include <NBO/Shared/Base/NBOBaseClass.h>


namespace Inscoper::NBO {

/*!
* \brief Represents the XML element ColoredBeads.
*
* This element describes a preparation of multi-Colored Fluorescent Beads (also referred to as  Microspheres) used to facilitate the optical calibration of conventional fluorescence microscopes, confocal laser scanning microscopes, and associated image-processing equipments. These Beads are usually made of glass or plastic microspheres stained with one or more fluorescent dyes.
*/
class NBO_EXPORT ColoredBeads : public ManufacturerSpec_Type {

public:
	
	ColoredBeads();
	~ColoredBeads();

	/*!
	* \brief Cast a NBOBaseClass to a ColoredBeads.
	*
	* \param base The base class to cast
	* \return The casted element, or nullptr if the cast fails
	*/
	static std::shared_ptr<ColoredBeads> 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 Diameter attribute.
	*
	* This field captures the Diameter of these Colored Beads.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setDiameter(const float& value, bool validate = true);

	/*!
	* \brief Returns the value of the Diameter attribute.
	*
	* This field captures the Diameter of these Colored Beads.
	*
	* \return The value of the attribute
	*/
	float getDiameter() const;

	/*!
	* \brief Resets the Diameter attribute to an unset state.
	*
	* This field captures the Diameter of these Colored Beads.
	*/
	void resetDiameter();

	/*!
	* \brief Checks whether the Diameter attribute is present.
	*
	* This field captures the Diameter of these Colored Beads.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasDiameter() const;

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

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

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

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

	/*!
	* \brief Sets the value of the Concentration attribute.
	*
	* This field captures the concentration of these Colored Beads.
	*
	* \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.
	*
	* This field captures the concentration of these Colored Beads.
	*
	* \return The value of the attribute
	*/
	float getConcentration() const;

	/*!
	* \brief Resets the Concentration attribute to an unset state.
	*
	* This field captures the concentration of these Colored Beads.
	*/
	void resetConcentration();

	/*!
	* \brief Checks whether the Concentration attribute is present.
	*
	* This field captures the concentration of these Colored Beads.
	*
	* \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 Type attribute.
	*
	* This field captures the type of these Colored Beads.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setType(const Inscoper::NBO::BeadType_TypePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the Type attribute.
	*
	* This field captures the type of these Colored Beads.
	*
	* \return The value of the attribute
	*/
	BeadType_TypePtr getType() const;

	/*!
	* \brief Resets the Type attribute to an unset state.
	*
	* This field captures the type of these Colored Beads.
	*/
	void resetType();

	/*!
	* \brief Checks whether the optional Type attribute is present.
	*
	* This field captures the type of these Colored Beads.
	*
	* \return true if the optional attribute has been set, false otherwise
	*/
	bool hasType() const;

	/*!
	* \brief Sets the value of the Material attribute.
	*
	* This field capture the Material that is used to construct these Colored Beads.
	*
	* \param value The value to set
	* \param validate If true, validates constraints on value. Default is true.
	*/
	void setMaterial(const std::string& value, bool validate = true);

	/*!
	* \brief Returns the value of the Material attribute.
	*
	* This field capture the Material that is used to construct these Colored Beads.
	*
	* \return The value of the attribute
	*/
	std::string getMaterial() const;

	/*!
	* \brief Resets the Material attribute to an unset state.
	*
	* This field capture the Material that is used to construct these Colored Beads.
	*/
	void resetMaterial();

	/*!
	* \brief Checks whether the Material attribute is present.
	*
	* This field capture the Material that is used to construct these Colored Beads.
	*
	* \return true if the attribute has been set, false otherwise
	*/
	bool hasMaterial() const;

	/*!
	* \brief Returns the allowed values for this attribut.
	*
	* This field capture the Material that is used to construct these Colored Beads.
	*
	* \return The list of allowed values
	*/
	static const std::set<std::string>& getMaterialAllowedValues();

	/*!
	* \brief Sets the value of the WavelengthRange element.
	*
	* 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 setWavelengthRange(const Inscoper::NBO::WavelengthRangePtr& value, bool validate = true);

	/*!
	* \brief Returns the value of the WavelengthRange element.
	*
	* No description available in the XSD standard.
	*
	* \return The value of the element
	*/
	Inscoper::NBO::WavelengthRangePtr getWavelengthRange() const
;
	/*!
	* \brief Resets the WavelengthRange element to an unset state.
	*
	* No description available in the XSD standard.
	*/
	void resetWavelengthRange();

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


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

	LSID_TypePtr ID = nullptr; // Required attribute
    std::optional<float> Diameter; // Required attribute
	UnitsLength_TypePtr DiameterUnit = nullptr; // Optional attribute
    std::optional<float> Concentration; // Required attribute
	UnitsConcentration_TypePtr ConcentrationUnit = nullptr; // Optional attribute
	BeadType_TypePtr Type = nullptr; // Optional attribute
    std::optional<std::string> Material; // Optional attribute
    static const std::set<std::string> MaterialAllowedValues;
    Inscoper::NBO::WavelengthRangePtr WavelengthRange = nullptr;
};

/*! Shared pointer for ColoredBeads*/
typedef std::shared_ptr<ColoredBeads> ColoredBeadsPtr;

} // namespace Inscoper::NBO

#endif // COLOREDBEADS_HPP_INCLUDED